diff options
| author |  Phil Hagelberg <phil@hagelb.org> | 2022-09-20 01:52:02 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2022-09-20 10:52:02 +0200 |
| commit | 8c20626c51b1d986b351e9f2e188675b54245420 (patch) | |
| tree | cd603f2a8d9299810b410bb3d92db0184eaa6488 /docs/admin/cli.md | |
| parent | don't error out if storage key already exists (#840) (diff) | |
| download | gotosocial-8c20626c51b1d986b351e9f2e188675b54245420.tar.xz | |
[docs] Add --config-path to example CLI commands where needed. (#843)
Previously we had a few examples referring to --config-file (which is
not accepted) but most were missing it altogether. Put this argument
last in all the examples.
Also replaced "./example.json" with just "example.json" in the
import/export examples because the "./" was unnecessary.
Diffstat (limited to 'docs/admin/cli.md')
| -rw-r--r-- | docs/admin/cli.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/admin/cli.md b/docs/admin/cli.md index 7a71f2fcd..e708a8a29 100644 --- a/docs/admin/cli.md +++ b/docs/admin/cli.md @@ -62,7 +62,8 @@ Example: gotosocial admin account create \ --username some_username \ --email someuser@example.org \ - --password 'somelongandcomplicatedpassword' + --password 'somelongandcomplicatedpassword' \ + --config-path config.yaml ``` ### gotosocial admin account confirm @@ -85,7 +86,7 @@ Flags: Example: ```bash -gotosocial admin account confirm --username some_username +gotosocial admin account confirm --username some_username --config-path config.yaml ``` ### gotosocial admin account promote @@ -108,7 +109,7 @@ Flags: Example: ```bash -gotosocial admin account promote --username some_username +gotosocial admin account promote --username some_username --config-path config.yaml ``` ### gotosocial admin account demote @@ -131,7 +132,7 @@ Flags: Example: ```bash -gotosocial admin account demote --username some_username +gotosocial admin account demote --username some_username --config-path config.yaml ``` ### gotosocial admin account disable @@ -154,7 +155,7 @@ Flags: Example: ```bash -gotosocial admin account disable --username some_username +gotosocial admin account disable --username some_username --config-path config.yaml ``` ### gotosocial admin account suspend @@ -179,7 +180,7 @@ Flags: Example: ```bash -gotosocial admin account suspend --username some_username +gotosocial admin account suspend --username some_username --config-path config.yaml ``` ### gotosocial admin account password @@ -203,7 +204,7 @@ Flags: Example: ```bash -gotosocial admin account password --username some_username --pasword some_really_good_password +gotosocial admin account password --username some_username --pasword some_really_good_password --config-path config.yaml ``` ### gotosocial admin export @@ -228,7 +229,7 @@ Flags: Example: ```bash -gotosocial admin export --config-file ./config.yaml --path ./example.json +gotosocial admin export --path example.json --config-path config.yaml ``` `example.json`: @@ -276,5 +277,5 @@ Flags: Example: ```bash -gotosocial admin import --config-file ./config.yaml --path ./example.json +gotosocial admin import --path example.json --config-path config.yaml ``` |