2a70b4aae2
* add docsmg tool * moved to the correct scripts directory * removed test files * added install script and readme draft to docsmg * fix install script * fixed issues * Revert "fixed issues" This reverts commita51192025f. * Revert "Revert "fixed issues"" This reverts commitab68918fea. * added dotenv and updated readme * fixed install script * update readme to ensure that new installers of rust have envs loaded
17 lines
979 B
Markdown
17 lines
979 B
Markdown
# Docsmg
|
|
|
|
## Steps to install
|
|
|
|
1. Verify that you have the latest version of rust installed
|
|
- Install [rust](rustup.rs) or update rust to the latest version with `rustup update`
|
|
- If installing rust from scratch, you may need to run `. $HOME/.cargo/env`
|
|
2. Install the cli tool with `cargo install --git https://github.com/goauthentik/authentik --bin docsmg`
|
|
|
|
## Steps to use
|
|
|
|
1. Generate a migratefile with `docsmg generate >> migratefile`
|
|
2. Find the files you want to move in `migratefile` and insert the path you want to move them to after the arrow; ex `path/to/move/from/file.md -> path/to/move/to/file.md` Note: make sure to put spaces on either side of the arrow or that line won't be recognized
|
|
3. Once you have entered all the paths you want to move, migrate the files with `docsmg migrate`
|
|
4. To revert the migration, use `docsmg unmigrate`; Note: DO NOT edit the migrate file inbetween steps 3 and 4
|
|
5. Repeat steps 2-4 until you are satified with the result
|