From e267e489c64ecb90876fed4036d08c906ce3da38 Mon Sep 17 00:00:00 2001 From: Alberto Ricart Date: Thu, 2 Jan 2025 10:45:57 -0600 Subject: [PATCH] Revert "Generate docs on every commit (#683)" (#689) This reverts commit 7db0e9bd422c1b5de58fe6cc7bb306883b0968cb. --- .github/workflows/pushes.yaml | 15 ---- docs/nsc.md | 14 ++-- docs/nsc_add.md | 7 +- docs/nsc_add_account.md | 11 +-- docs/nsc_add_export.md | 8 ++- docs/nsc_add_import.md | 8 ++- docs/nsc_add_mapping.md | 7 +- docs/nsc_add_operator.md | 11 +-- docs/nsc_add_user.md | 11 +-- docs/nsc_completion.md | 38 ---------- docs/nsc_completion_bash.md | 57 --------------- docs/nsc_completion_fish.md | 48 ------------- docs/nsc_completion_powershell.md | 45 ------------ docs/nsc_completion_zsh.md | 59 ---------------- docs/nsc_delete.md | 7 +- docs/nsc_delete_account.md | 7 +- docs/nsc_delete_export.md | 7 +- docs/nsc_delete_import.md | 7 +- docs/nsc_delete_mapping.md | 8 ++- docs/nsc_delete_user.md | 7 +- docs/nsc_describe.md | 7 +- docs/nsc_describe_account.md | 7 +- docs/nsc_describe_jwt.md | 9 ++- docs/nsc_describe_operator.md | 7 +- docs/nsc_describe_user.md | 7 +- docs/nsc_edit.md | 8 ++- docs/nsc_edit_account.md | 82 ++++++++++------------ docs/nsc_edit_authcallout.md | 40 ----------- docs/nsc_edit_export.md | 8 ++- docs/nsc_edit_operator.md | 19 ++--- docs/nsc_edit_signing-key.md | 8 +-- docs/nsc_edit_user.md | 11 ++- docs/nsc_env.md | 7 +- docs/nsc_expirations.md | 45 ------------ docs/nsc_export.md | 7 +- docs/nsc_export_keys.md | 10 +-- docs/nsc_generate.md | 9 +-- docs/nsc_generate_activation.md | 11 +-- docs/nsc_generate_config.md | 7 +- docs/nsc_generate_context.md | 41 ----------- docs/nsc_generate_creds.md | 7 +- docs/nsc_generate_diagram.md | 7 +- docs/nsc_generate_diagram_component.md | 7 +- docs/nsc_generate_diagram_object.md | 7 +- docs/nsc_generate_nkey.md | 8 ++- docs/nsc_generate_profile.md | 85 ----------------------- docs/nsc_import.md | 7 +- docs/nsc_import_account.md | 7 +- docs/nsc_import_keys.md | 5 +- docs/nsc_import_user.md | 7 +- docs/nsc_init.md | 28 +++++--- docs/nsc_keys.md | 7 +- docs/nsc_keys_migrate.md | 7 +- docs/nsc_list.md | 7 +- docs/nsc_list_accounts.md | 7 +- docs/nsc_list_keys.md | 4 +- docs/nsc_list_operators.md | 7 +- docs/nsc_list_users.md | 7 +- docs/nsc_load.md | 36 ---------- docs/nsc_pull.md | 7 +- docs/nsc_push.md | 8 ++- docs/nsc_reissue.md | 13 ++-- docs/nsc_reissue_operator.md | 13 ++-- docs/nsc_revocations.md | 7 +- docs/nsc_revocations_add-user.md | 9 ++- docs/nsc_revocations_add_activation.md | 9 ++- docs/nsc_revocations_delete-user.md | 7 +- docs/nsc_revocations_delete_activation.md | 7 +- docs/nsc_revocations_list-users.md | 7 +- docs/nsc_revocations_list_activations.md | 7 +- docs/nsc_select.md | 30 -------- docs/nsc_select_account.md | 32 --------- docs/nsc_select_operator.md | 32 --------- docs/nsc_tool.md | 7 +- docs/nsc_tool_pub.md | 7 +- docs/nsc_tool_reply.md | 7 +- docs/nsc_tool_req.md | 7 +- docs/nsc_tool_rtt.md | 7 +- docs/nsc_tool_sub.md | 7 +- docs/nsc_update.md | 7 +- docs/nsc_validate.md | 7 +- 81 files changed, 385 insertions(+), 848 deletions(-) delete mode 100644 docs/nsc_completion.md delete mode 100644 docs/nsc_completion_bash.md delete mode 100644 docs/nsc_completion_fish.md delete mode 100644 docs/nsc_completion_powershell.md delete mode 100644 docs/nsc_completion_zsh.md delete mode 100644 docs/nsc_edit_authcallout.md delete mode 100644 docs/nsc_expirations.md delete mode 100644 docs/nsc_generate_context.md delete mode 100644 docs/nsc_generate_profile.md delete mode 100644 docs/nsc_load.md delete mode 100644 docs/nsc_select.md delete mode 100644 docs/nsc_select_account.md delete mode 100644 docs/nsc_select_operator.md diff --git a/.github/workflows/pushes.yaml b/.github/workflows/pushes.yaml index 42ec2b85..1057a438 100644 --- a/.github/workflows/pushes.yaml +++ b/.github/workflows/pushes.yaml @@ -29,9 +29,6 @@ on: jobs: test: runs-on: ${{ matrix.os }} - permissions: - contents: write - continue-on-error: ${{ matrix.experimental || false }} strategy: # Debugging multi-platform builds, let them all complete (for now) @@ -55,7 +52,6 @@ jobs: - name: Checkout uses: actions/checkout@v4 with: - ref: ${{ github.head_ref }} fetch-depth: 0 - name: Set up Go @@ -129,17 +125,6 @@ jobs: COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }} if: matrix.canonical - - name: Generate docs - run: go run ./ test doc docs - if: matrix.os == 'ubuntu-latest' - - - name: Auto-commit generated docs - uses: stefanzweifel/git-auto-commit-action@v5 - with: - commit_message: Auto-commit docs - file_pattern: docs/** - if: matrix.os == 'ubuntu-latest' - - name: Bad versions creep defense id: go-module-versions # The go.mod includes tests, and some of our tests explicitly pull in jwtv1, which is unmaintained and has security issues. diff --git a/docs/nsc.md b/docs/nsc.md index ef72da55..4047552d 100644 --- a/docs/nsc.md +++ b/docs/nsc.md @@ -2,14 +2,13 @@ nsc creates NATS operators, accounts, users, and manage their permissions. -``` -nsc [flags] -``` +### Synopsis + +nsc creates NATS operators, accounts, users, and manage their permissions. ### Options ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -h, --help help for nsc @@ -18,32 +17,27 @@ nsc [flags] -K, --private-key string Key used to sign. Can be specified as role (where applicable), public key (private portion is retrieved) or file path to a private key or private key - -v, --version version for nsc ``` ### SEE ALSO * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -* [nsc completion](nsc_completion.md) - Generate the autocompletion script for the specified shell * [nsc delete](nsc_delete.md) - Delete imports and exports * [nsc describe](nsc_describe.md) - Describe assets such as operators, accounts, users, and jwt files * [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users * [nsc env](nsc_env.md) - Prints and manage the nsc environment -* [nsc expirations](nsc_expirations.md) - Create a new expiration report * [nsc export](nsc_export.md) - Export assets such as nkeys * [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys * [nsc import](nsc_import.md) - Import assets such as nkeys * [nsc init](nsc_init.md) - Initialize an environment by creating an operator, account and user * [nsc keys](nsc_keys.md) - Manage keys for operators, accounts, and users * [nsc list](nsc_list.md) - List assets such as accounts, imports, users -* [nsc load](nsc_load.md) - install entities for an operator, account and key * [nsc pull](nsc_pull.md) - Pull an operator or account jwt replacing the local jwt with the server's version * [nsc push](nsc_push.md) - Push an account jwt to an Account JWT Server * [nsc reissue](nsc_reissue.md) - Re-issue objects with a new identity key * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -* [nsc select](nsc_select.md) - Set the current operator or account * [nsc tool](nsc_tool.md) - NATS tools: pub, sub, req, rep, rtt * [nsc update](nsc_update.md) - Update this tool to latest version * [nsc validate](nsc_validate.md) - Validate an operator, account(s), and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add.md b/docs/nsc_add.md index 071dafa7..d3356003 100644 --- a/docs/nsc_add.md +++ b/docs/nsc_add.md @@ -2,6 +2,10 @@ Add assets such as accounts, imports, users +### Synopsis + +Add assets such as accounts, imports, users + ### Options ``` @@ -11,7 +15,6 @@ Add assets such as accounts, imports, users ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -31,4 +34,4 @@ Add assets such as accounts, imports, users * [nsc add operator](nsc_add_operator.md) - Add an operator * [nsc add user](nsc_add_user.md) - Add an user to the account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add_account.md b/docs/nsc_add_account.md index af65b4b7..b94a3bd8 100644 --- a/docs/nsc_add_account.md +++ b/docs/nsc_add_account.md @@ -2,6 +2,10 @@ Add an account +### Synopsis + +Add an account + ``` nsc add account [flags] ``` @@ -16,18 +20,17 @@ nsc add account [flags] --deny-pub strings add deny publish default permissions - comma separated list or option can be specified multiple times --deny-pubsub strings add deny publish and subscribe default permissions - comma separated list or option can be specified multiple times --deny-sub strings add deny subscribe default permissions - comma separated list or option can be specified multiple times - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -h, --help help for account -n, --name string account name -k, --public-key string public key identifying the account --response-ttl string the amount of time the default permissions is valid (global) - [#ms(millis) | #s(econds) | m(inutes) | h(ours)] - Default is no time limit. - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") ``` ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +44,4 @@ nsc add account [flags] * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add_export.md b/docs/nsc_add_export.md index bc91498d..a3c1e037 100644 --- a/docs/nsc_add_export.md +++ b/docs/nsc_add_export.md @@ -2,6 +2,10 @@ Add an export +### Synopsis + +Add an export + ``` nsc add export [flags] ``` @@ -20,7 +24,6 @@ nsc add export --name myexport --subject a.b --service ``` -a, --account string account name --account-token-position uint subject token position where account is expected (public exports only) - --allow-trace allow trace requests -h, --help help for export --latency string latency metrics subject (services only) -n, --name string export name @@ -35,7 +38,6 @@ nsc add export --name myexport --subject a.b --service ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -49,4 +51,4 @@ nsc add export --name myexport --subject a.b --service * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add_import.md b/docs/nsc_add_import.md index 8d5db119..8fbaa406 100644 --- a/docs/nsc_add_import.md +++ b/docs/nsc_add_import.md @@ -2,6 +2,10 @@ Add an import +### Synopsis + +Add an import + ``` nsc add import [flags] ``` @@ -19,7 +23,6 @@ nsc add import --src-account --remote-subject --lo ``` -a, --account string account name - --allow-trace allow trace requests -h, --help help for import -s, --local-subject string local subject -n, --name string import name @@ -33,7 +36,6 @@ nsc add import --src-account --remote-subject --lo ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -47,4 +49,4 @@ nsc add import --src-account --remote-subject --lo * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add_mapping.md b/docs/nsc_add_mapping.md index b894d873..69cd58cb 100644 --- a/docs/nsc_add_mapping.md +++ b/docs/nsc_add_mapping.md @@ -2,6 +2,10 @@ Add (or modify) a mapping entry +### Synopsis + +Add (or modify) a mapping entry + ``` nsc add mapping [flags] ``` @@ -31,7 +35,6 @@ nsc add mapping --from "a" --to "c" --weight 50 ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -45,4 +48,4 @@ nsc add mapping --from "a" --to "c" --weight 50 * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add_operator.md b/docs/nsc_add_operator.md index 708795ff..a7acbe06 100644 --- a/docs/nsc_add_operator.md +++ b/docs/nsc_add_operator.md @@ -2,6 +2,10 @@ Add an operator +### Synopsis + +Add an operator + ``` nsc add operator [flags] ``` @@ -9,12 +13,12 @@ nsc add operator [flags] ### Options ``` - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") --force on import, overwrite existing when already present --generate-signing-key generate a signing key with the operator -h, --help help for operator -n, --name string operator name - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -s, --sys generate system account with the operator (if specified will be signed with signing key) -u, --url string import from a jwt server url, file, or well known operator ``` @@ -22,7 +26,6 @@ nsc add operator [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -36,4 +39,4 @@ nsc add operator [flags] * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_add_user.md b/docs/nsc_add_user.md index 242fdabb..940cc32d 100644 --- a/docs/nsc_add_user.md +++ b/docs/nsc_add_user.md @@ -2,6 +2,10 @@ Add an user to the account +### Synopsis + +Add an user to the account + ``` nsc add user [flags] ``` @@ -54,20 +58,19 @@ nsc add user --name --allow-pub-response=5 --deny-pub strings add deny publish permissions - comma separated list or option can be specified multiple times --deny-pubsub strings add deny publish and subscribe permissions - comma separated list or option can be specified multiple times --deny-sub strings add deny subscribe permissions - comma separated list or option can be specified multiple times - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -h, --help help for user -n, --name string name to assign the user -k, --public-key string public key identifying the user --response-ttl string the amount of time the permissions is valid (global) - [#ms(millis) | #s(econds) | m(inutes) | h(ours)] - Default is no time limit. --source-network strings source network for connection - comma separated list or option can be specified multiple times - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") --tag strings tags for user - comma separated list or option can be specified multiple times ``` ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -81,4 +84,4 @@ nsc add user --name --allow-pub-response=5 * [nsc add](nsc_add.md) - Add assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_completion.md b/docs/nsc_completion.md deleted file mode 100644 index 0d468649..00000000 --- a/docs/nsc_completion.md +++ /dev/null @@ -1,38 +0,0 @@ -## nsc completion - -Generate the autocompletion script for the specified shell - -### Synopsis - -Generate the autocompletion script for nsc for the specified shell. -See each sub-command's help for details on how to use the generated script. - - -### Options - -``` - -h, --help help for completion -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -* [nsc completion bash](nsc_completion_bash.md) - Generate the autocompletion script for bash -* [nsc completion fish](nsc_completion_fish.md) - Generate the autocompletion script for fish -* [nsc completion powershell](nsc_completion_powershell.md) - Generate the autocompletion script for powershell -* [nsc completion zsh](nsc_completion_zsh.md) - Generate the autocompletion script for zsh - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_completion_bash.md b/docs/nsc_completion_bash.md deleted file mode 100644 index ec7c5300..00000000 --- a/docs/nsc_completion_bash.md +++ /dev/null @@ -1,57 +0,0 @@ -## nsc completion bash - -Generate the autocompletion script for bash - -### Synopsis - -Generate the autocompletion script for the bash shell. - -This script depends on the 'bash-completion' package. -If it is not installed already, you can install it via your OS's package manager. - -To load completions in your current shell session: - - source <(nsc completion bash) - -To load completions for every new session, execute once: - -#### Linux: - - nsc completion bash > /etc/bash_completion.d/nsc - -#### macOS: - - nsc completion bash > $(brew --prefix)/etc/bash_completion.d/nsc - -You will need to start a new shell for this setup to take effect. - - -``` -nsc completion bash -``` - -### Options - -``` - -h, --help help for bash - --no-descriptions disable completion descriptions -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc completion](nsc_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_completion_fish.md b/docs/nsc_completion_fish.md deleted file mode 100644 index 1251d42c..00000000 --- a/docs/nsc_completion_fish.md +++ /dev/null @@ -1,48 +0,0 @@ -## nsc completion fish - -Generate the autocompletion script for fish - -### Synopsis - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - - nsc completion fish | source - -To load completions for every new session, execute once: - - nsc completion fish > ~/.config/fish/completions/nsc.fish - -You will need to start a new shell for this setup to take effect. - - -``` -nsc completion fish [flags] -``` - -### Options - -``` - -h, --help help for fish - --no-descriptions disable completion descriptions -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc completion](nsc_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_completion_powershell.md b/docs/nsc_completion_powershell.md deleted file mode 100644 index 2807fa18..00000000 --- a/docs/nsc_completion_powershell.md +++ /dev/null @@ -1,45 +0,0 @@ -## nsc completion powershell - -Generate the autocompletion script for powershell - -### Synopsis - -Generate the autocompletion script for powershell. - -To load completions in your current shell session: - - nsc completion powershell | Out-String | Invoke-Expression - -To load completions for every new session, add the output of the above command -to your powershell profile. - - -``` -nsc completion powershell [flags] -``` - -### Options - -``` - -h, --help help for powershell - --no-descriptions disable completion descriptions -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc completion](nsc_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_completion_zsh.md b/docs/nsc_completion_zsh.md deleted file mode 100644 index e412dbb2..00000000 --- a/docs/nsc_completion_zsh.md +++ /dev/null @@ -1,59 +0,0 @@ -## nsc completion zsh - -Generate the autocompletion script for zsh - -### Synopsis - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: - - echo "autoload -U compinit; compinit" >> ~/.zshrc - -To load completions in your current shell session: - - source <(nsc completion zsh) - -To load completions for every new session, execute once: - -#### Linux: - - nsc completion zsh > "${fpath[1]}/_nsc" - -#### macOS: - - nsc completion zsh > $(brew --prefix)/share/zsh/site-functions/_nsc - -You will need to start a new shell for this setup to take effect. - - -``` -nsc completion zsh [flags] -``` - -### Options - -``` - -h, --help help for zsh - --no-descriptions disable completion descriptions -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc completion](nsc_completion.md) - Generate the autocompletion script for the specified shell - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_delete.md b/docs/nsc_delete.md index 564987bf..52d71266 100644 --- a/docs/nsc_delete.md +++ b/docs/nsc_delete.md @@ -2,6 +2,10 @@ Delete imports and exports +### Synopsis + +Delete imports and exports + ### Options ``` @@ -11,7 +15,6 @@ Delete imports and exports ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -30,4 +33,4 @@ Delete imports and exports * [nsc delete mapping](nsc_delete_mapping.md) - Delete a mapping * [nsc delete user](nsc_delete_user.md) - Delete an user -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_delete_account.md b/docs/nsc_delete_account.md index d0721584..b40b4aff 100644 --- a/docs/nsc_delete_account.md +++ b/docs/nsc_delete_account.md @@ -2,6 +2,10 @@ Delete an account and associated users +### Synopsis + +Delete an account and associated users + ``` nsc delete account [flags] ``` @@ -28,7 +32,6 @@ nsc delete account -i ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -42,4 +45,4 @@ nsc delete account -i * [nsc delete](nsc_delete.md) - Delete imports and exports -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_delete_export.md b/docs/nsc_delete_export.md index 8daea47f..b3c36746 100644 --- a/docs/nsc_delete_export.md +++ b/docs/nsc_delete_export.md @@ -2,6 +2,10 @@ Delete an export +### Synopsis + +Delete an export + ``` nsc delete export [flags] ``` @@ -17,7 +21,6 @@ nsc delete export [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -31,4 +34,4 @@ nsc delete export [flags] * [nsc delete](nsc_delete.md) - Delete imports and exports -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_delete_import.md b/docs/nsc_delete_import.md index 7748c556..58e70856 100644 --- a/docs/nsc_delete_import.md +++ b/docs/nsc_delete_import.md @@ -2,6 +2,10 @@ Delete an import +### Synopsis + +Delete an import + ``` nsc delete import [flags] ``` @@ -25,7 +29,6 @@ nsc delete import -s "bar.>" ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -39,4 +42,4 @@ nsc delete import -s "bar.>" * [nsc delete](nsc_delete.md) - Delete imports and exports -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_delete_mapping.md b/docs/nsc_delete_mapping.md index 0f30d7a4..8b422f2e 100644 --- a/docs/nsc_delete_mapping.md +++ b/docs/nsc_delete_mapping.md @@ -2,6 +2,10 @@ Delete a mapping +### Synopsis + +Delete a mapping + ``` nsc delete mapping [flags] ``` @@ -10,7 +14,6 @@ nsc delete mapping [flags] ``` -a, --account string account name - --cluster string in which cluster this mapping should apply -f, --from string map from subject (required) -h, --help help for mapping -t, --to string to subject. When present, only that particular mapping is removed. Otherwise all mappings for from subject are. @@ -19,7 +22,6 @@ nsc delete mapping [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -33,4 +35,4 @@ nsc delete mapping [flags] * [nsc delete](nsc_delete.md) - Delete imports and exports -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_delete_user.md b/docs/nsc_delete_user.md index 7bf01f9f..5af28c74 100644 --- a/docs/nsc_delete_user.md +++ b/docs/nsc_delete_user.md @@ -2,6 +2,10 @@ Delete an user +### Synopsis + +Delete an user + ``` nsc delete user [flags] ``` @@ -27,7 +31,6 @@ nsc delete user -i ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +44,4 @@ nsc delete user -i * [nsc delete](nsc_delete.md) - Delete imports and exports -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_describe.md b/docs/nsc_describe.md index eeba7d30..ec8233bf 100644 --- a/docs/nsc_describe.md +++ b/docs/nsc_describe.md @@ -2,6 +2,10 @@ Describe assets such as operators, accounts, users, and jwt files +### Synopsis + +Describe assets such as operators, accounts, users, and jwt files + ### Options ``` @@ -15,7 +19,6 @@ Describe assets such as operators, accounts, users, and jwt files ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -33,4 +36,4 @@ Describe assets such as operators, accounts, users, and jwt files * [nsc describe operator](nsc_describe_operator.md) - Describes the operator * [nsc describe user](nsc_describe_user.md) - Describes an user -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_describe_account.md b/docs/nsc_describe_account.md index 280985d5..205dd492 100644 --- a/docs/nsc_describe_account.md +++ b/docs/nsc_describe_account.md @@ -2,6 +2,10 @@ Describes an account +### Synopsis + +Describes an account + ``` nsc describe account [flags] ``` @@ -17,7 +21,6 @@ nsc describe account [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -F, --field string extract value from specified field using json structure @@ -35,4 +38,4 @@ nsc describe account [flags] * [nsc describe](nsc_describe.md) - Describe assets such as operators, accounts, users, and jwt files -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_describe_jwt.md b/docs/nsc_describe_jwt.md index fdcd5163..57143435 100644 --- a/docs/nsc_describe_jwt.md +++ b/docs/nsc_describe_jwt.md @@ -2,6 +2,10 @@ Describe a jwt/creds file +### Synopsis + +Describe a jwt/creds file + ``` nsc describe jwt [flags] ``` @@ -9,7 +13,7 @@ nsc describe jwt [flags] ### Examples ``` -nsc describe jwt -f pathorurl +nsc describe -f pathorurl ``` ### Options @@ -23,7 +27,6 @@ nsc describe jwt -f pathorurl ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -F, --field string extract value from specified field using json structure @@ -41,4 +44,4 @@ nsc describe jwt -f pathorurl * [nsc describe](nsc_describe.md) - Describe assets such as operators, accounts, users, and jwt files -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_describe_operator.md b/docs/nsc_describe_operator.md index 43a6ba41..7fa04bfc 100644 --- a/docs/nsc_describe_operator.md +++ b/docs/nsc_describe_operator.md @@ -2,6 +2,10 @@ Describes the operator +### Synopsis + +Describes the operator + ``` nsc describe operator [flags] ``` @@ -17,7 +21,6 @@ nsc describe operator [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -F, --field string extract value from specified field using json structure @@ -35,4 +38,4 @@ nsc describe operator [flags] * [nsc describe](nsc_describe.md) - Describe assets such as operators, accounts, users, and jwt files -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_describe_user.md b/docs/nsc_describe_user.md index a02fee9b..2eb6c660 100644 --- a/docs/nsc_describe_user.md +++ b/docs/nsc_describe_user.md @@ -2,6 +2,10 @@ Describes an user +### Synopsis + +Describes an user + ``` nsc describe user [flags] ``` @@ -18,7 +22,6 @@ nsc describe user [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -F, --field string extract value from specified field using json structure @@ -36,4 +39,4 @@ nsc describe user [flags] * [nsc describe](nsc_describe.md) - Describe assets such as operators, accounts, users, and jwt files -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_edit.md b/docs/nsc_edit.md index e9886ab3..95dfa23a 100644 --- a/docs/nsc_edit.md +++ b/docs/nsc_edit.md @@ -2,6 +2,10 @@ Edit assets such as accounts, imports, and users +### Synopsis + +Edit assets such as accounts, imports, and users + ### Options ``` @@ -11,7 +15,6 @@ Edit assets such as accounts, imports, and users ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -25,10 +28,9 @@ Edit assets such as accounts, imports, and users * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. * [nsc edit account](nsc_edit_account.md) - Edit an account -* [nsc edit authcallout](nsc_edit_authcallout.md) - Edit an account authorization callout * [nsc edit export](nsc_edit_export.md) - Edit an export * [nsc edit operator](nsc_edit_operator.md) - Edit the operator * [nsc edit signing-key](nsc_edit_signing-key.md) - Edit a scoped signing key or promote a signing key to be scoped * [nsc edit user](nsc_edit_user.md) - Edit an user -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_edit_account.md b/docs/nsc_edit_account.md index 539473ef..bb151ac1 100644 --- a/docs/nsc_edit_account.md +++ b/docs/nsc_edit_account.md @@ -2,6 +2,10 @@ Edit an account +### Synopsis + +Edit an account + ``` nsc edit account [flags] ``` @@ -9,55 +13,43 @@ nsc edit account [flags] ### Options ``` - --allow-pub strings add publish default permissions - comma separated list or option can be specified multiple times - --allow-pub-response int[=1] default permissions to limit how often a client can publish to reply subjects [with an optional count, --allow-pub-response=n] (global) - --allow-pubsub strings add publish and subscribe default permissions - comma separated list or option can be specified multiple times - --allow-sub strings add subscribe default permissions - comma separated list or option can be specified multiple times - --conns number set maximum active connections for the account (-1 is unlimited) (default -1) - --data number set maximum data in bytes for the account (-1 is unlimited) (default -1) - --deny-pub strings add deny publish default permissions - comma separated list or option can be specified multiple times - --deny-pubsub strings add deny publish and subscribe default permissions - comma separated list or option can be specified multiple times - --deny-sub strings add deny subscribe default permissions - comma separated list or option can be specified multiple times - --description string Description for this account - --disallow-bearer require user jwt to not be bearer token - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) - --exports number set maximum number of exports for the account (-1 is unlimited) (default -1) - -h, --help help for account - --imports number set maximum number of imports for the account (-1 is unlimited) (default -1) - --info-url string Link for more info on this account - --js-consumer number JetStream: set maximum consumer for the account (-1 is unlimited) (default -1) - --js-disable disables all JetStream limits in the account by deleting any limits - --js-disk-storage number JetStream: set maximum disk storage in bytes for the account (-1 is unlimited / 0 disabled) (units: k/m/g/t kib/mib/gib/tib) - --js-enable int enables JetStream for the specified tier (default -1) - --js-max-ack-pending number JetStream: set number of maximum acks that can be pending for a consumer in the account (default -1) - --js-max-bytes-required JetStream: set whether max stream is required when creating a stream - --js-max-disk-stream number JetStream: set maximum size of a disk stream for the account (-1 is unlimited / 0 disabled) (units: k/m/g/t kib/mib/gib/tib) (default -1) - --js-max-mem-stream number JetStream: set maximum size of a memory stream for the account (-1 is unlimited / 0 disabled) (units: k/m/g/t kib/mib/gib/tib) (default -1) - --js-mem-storage number JetStream: set maximum memory storage in bytes for the account (-1 is unlimited / 0 disabled) (units: k/m/g/t kib/mib/gib/tib) - --js-streams number JetStream: set maximum streams for the account (-1 is unlimited) (default -1) - --js-tier int JetStream: replication tier (0 creates a configuration that applies to all assets) - --leaf-conns number set maximum active leaf node connections for the account (-1 is unlimited) - -n, --name string account to edit - --payload number set maximum message payload in bytes for the account (-1 is unlimited) (default -1) - --response-ttl string the amount of time the default permissions is valid (global) - [#ms(millis) | #s(econds) | m(inutes) | h(ours)] - Default is no time limit. - --rm strings remove publish/subscribe and deny default permissions - comma separated list or option can be specified multiple times - --rm-js-tier int JetStream: remove replication limits for the specified tier (0 is the global tier) this flag is exclusive of all other js flags (default -1) - --rm-response-perms remove response settings from default permissions - --rm-sk strings remove signing key - comma separated list or option can be specified multiple times - --rm-tag strings remove tag - comma separated list or option can be specified multiple times - --sk strings signing key or keypath or the value "generate" to generate a key pair on the fly - comma separated list or option can be specified multiple times - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) - --subscriptions number set maximum subscription for the account (-1 is unlimited) (default -1) - --tag strings add tags for user - comma separated list or option can be specified multiple times - --trace-context-sampling number set the trace context sampling rate (1-100) - 0 default is 100 - --trace-context-subject string sets the subject where w3c trace context information is sent. Set to "" to disable (default "trace.messages") - --wildcard-exports exports can contain wildcards (default true) + --allow-pub strings add publish default permissions - comma separated list or option can be specified multiple times + --allow-pub-response int[=1] default permissions to limit how often a client can publish to reply subjects [with an optional count, --allow-pub-response=n] (global) + --allow-pubsub strings add publish and subscribe default permissions - comma separated list or option can be specified multiple times + --allow-sub strings add subscribe default permissions - comma separated list or option can be specified multiple times + --conns number set maximum active connections for the account (-1 is unlimited) (default -1) + --data number set maximum data in bytes for the account (-1 is unlimited) (default -1) + --deny-pub strings add deny publish default permissions - comma separated list or option can be specified multiple times + --deny-pubsub strings add deny publish and subscribe default permissions - comma separated list or option can be specified multiple times + --deny-sub strings add deny subscribe default permissions - comma separated list or option can be specified multiple times + --description string Description for this account + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") + --exports number set maximum number of exports for the account (-1 is unlimited) (default -1) + -h, --help help for account + --imports number set maximum number of imports for the account (-1 is unlimited) (default -1) + --info-url string Link for more info on this account + --js-consumer number Jetstream: set maximum consumer for the account (-1 is unlimited) (default -1) + --js-disk-storage number Jetstream: set maximum disk storage in bytes for the account (-1 is unlimited / 0 disabled) (units: k/m/g/t kib/mib/gib/tib) + --js-mem-storage number Jetstream: set maximum memory storage in bytes for the account (-1 is unlimited / 0 disabled) (units: k/m/g/t kib/mib/gib/tib) + --js-streams number Jetstream: set maximum streams for the account (-1 is unlimited) (default -1) + --leaf-conns number set maximum active leaf node connections for the account (-1 is unlimited) + -n, --name string account to edit + --payload number set maximum message payload in bytes for the account (-1 is unlimited) (default -1) + --response-ttl string the amount of time the default permissions is valid (global) - [#ms(millis) | #s(econds) | m(inutes) | h(ours)] - Default is no time limit. + --rm strings remove publish/subscribe and deny default permissions - comma separated list or option can be specified multiple times + --rm-response-perms remove response settings from default permissions + --rm-sk strings remove signing key - comma separated list or option can be specified multiple times + --rm-tag strings remove tag - comma separated list or option can be specified multiple times + --sk strings signing key or keypath or the value "generate"" to generate a key pair on the fly - comma separated list or option can be specified multiple times + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") + --subscriptions number set maximum subscription for the account (-1 is unlimited) (default -1) + --tag strings add tags for user - comma separated list or option can be specified multiple times + --wildcard-exports exports can contain wildcards (default true) ``` ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -71,4 +63,4 @@ nsc edit account [flags] * [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_edit_authcallout.md b/docs/nsc_edit_authcallout.md deleted file mode 100644 index 44361f24..00000000 --- a/docs/nsc_edit_authcallout.md +++ /dev/null @@ -1,40 +0,0 @@ -## nsc edit authcallout - -Edit an account authorization callout - -``` -nsc edit authcallout [flags] -``` - -### Options - -``` - -a, --account string account name - --allowed-account strings adds an account public key that the authorization service can bind authorized users to (specify '*' to allow any account that the service can generate users for) - --auth-user strings adds a user public key that bypasses the authorization callout and is used by the authorization service itself - -x, --curve string curve key or keypath or the value "generate" to generate a curve encryption target key on the fly - --disable disable external authorization - -h, --help help for authcallout - --rm-allowed-account strings removes an account public key or the '*' wildcard that the authorization service can bind authorized users to - --rm-auth-user strings removes a user public key that bypasses the authorization callout and is used by the authorization service itself - --rm-curve remove curve encryption target -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_edit_export.md b/docs/nsc_edit_export.md index 9ad26f88..9aabd8f7 100644 --- a/docs/nsc_edit_export.md +++ b/docs/nsc_edit_export.md @@ -2,6 +2,10 @@ Edit an export +### Synopsis + +Edit an export + ``` nsc edit export [flags] ``` @@ -10,7 +14,6 @@ nsc edit export [flags] ``` -a, --account string account name - --allow-trace allow trace requests --description string Description for this export -h, --help help for export --info-url string Link for more info on this export @@ -28,7 +31,6 @@ nsc edit export [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -42,4 +44,4 @@ nsc edit export [flags] * [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_edit_operator.md b/docs/nsc_edit_operator.md index 2f143844..ee438e9d 100644 --- a/docs/nsc_edit_operator.md +++ b/docs/nsc_edit_operator.md @@ -2,6 +2,10 @@ Edit the operator +### Synopsis + +Edit the operator + ``` nsc edit operator [flags] ``` @@ -9,17 +13,17 @@ nsc edit operator [flags] ### Options ``` - -u, --account-jwt-server-url string set account jwt server url for nsc sync (only http/https or nats service (nats/tls/ws/wss) urls supported if updating with nsc) - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + -u, --account-jwt-server-url string set account jwt server url for nsc sync (only http/https/nats urls supported if updating with nsc) + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -h, --help help for operator --require-signing-keys require accounts/user to be signed with a signing key --rm-account-jwt-server-url clear account server url - --rm-service-url strings remove an operator service url for nsc where clients can access the NATS service (only nats/tls/ws/wss urls supported) + --rm-service-url strings remove an operator service url for nsc where clients can access the NATS service (only nats/tls urls supported) --rm-sk strings remove signing key - comma separated list or option can be specified multiple times --rm-tag strings remove tag - comma separated list or option can be specified multiple times - -n, --service-url strings add an operator service url for nsc where clients can access the NATS service (only nats/tls/ws/wss urls supported) - --sk strings signing key or keypath or the value "generate" to generate a key pair on the fly - comma separated list or option can be specified multiple times - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + -n, --service-url strings add an operator service url for nsc where clients can access the NATS service (only nats/tls urls supported) + --sk strings signing key or keypath or the value "generate"" to generate a key pair on the fly - comma separated list or option can be specified multiple times + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") --system-account string set system account by account by public key or name --tag strings add tags for user - comma separated list or option can be specified multiple times ``` @@ -27,7 +31,6 @@ nsc edit operator [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +44,4 @@ nsc edit operator [flags] * [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_edit_signing-key.md b/docs/nsc_edit_signing-key.md index 25acb278..8c4fe198 100644 --- a/docs/nsc_edit_signing-key.md +++ b/docs/nsc_edit_signing-key.md @@ -23,12 +23,11 @@ nsc edit signing-key [flags] --allow-pubsub strings add publish and subscribe permissions - comma separated list or option can be specified multiple times --allow-sub strings add subscribe permissions - comma separated list or option can be specified multiple times --bearer no connect challenge required for user - --conn-type strings set allowed connection types: LEAFNODE MQTT STANDARD WEBSOCKET LEAFNODE_WS MQTT_WS IN_PROCESS - comma separated list or option can be specified multiple times + --conn-type strings set allowed connection types: LEAFNODE MQTT STANDARD WEBSOCKET LEAFNODE_WS MQTT_WS - comma separated list or option can be specified multiple times --data number set maximum data in bytes for the user (-1 is unlimited) (default -1) --deny-pub strings add deny publish permissions - comma separated list or option can be specified multiple times --deny-pubsub strings add deny publish and subscribe permissions - comma separated list or option can be specified multiple times --deny-sub strings add deny subscribe permissions - comma separated list or option can be specified multiple times - --description string user description associated with the role -h, --help help for signing-key --locale time-locale set the locale with which time values are interpreted --payload number set maximum message payload in bytes for the account (-1 is unlimited) (default -1) @@ -39,7 +38,7 @@ nsc edit signing-key [flags] --rm-source-network strings remove source network for connection - comma separated list or option can be specified multiple times --rm-time strings remove start-end time by start time "hh:mm:ss" (option can be specified multiple times) --role string role associated with the signing key scope - --sk strings signing key or keypath or the value "generate" to generate a key pair on the fly + --sk string signing key to set scope for or role name for already existing scoped signing key --source-network strings add source network for connection - comma separated list or option can be specified multiple times --subs int set maximum number of subscriptions (-1 is unlimited) (default -1) --time time-ranges add start-end time range of the form "hh:mm:ss-hh:mm:ss" (option can be specified multiple times) (default []) @@ -48,7 +47,6 @@ nsc edit signing-key [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -62,4 +60,4 @@ nsc edit signing-key [flags] * [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_edit_user.md b/docs/nsc_edit_user.md index 946a1ba5..391a4005 100644 --- a/docs/nsc_edit_user.md +++ b/docs/nsc_edit_user.md @@ -25,7 +25,7 @@ nsc edit user --name --rm ,... # To dynamically allow publishing to reply subjects, this works well for service responders: nsc edit user --name --allow-pub-response -# A permission to publish a response can be removed after a duration from when +# A permission to publish a response can be removed after a duration from when # the message was received: nsc edit user --name --allow-pub-response --response-ttl 5s @@ -51,12 +51,12 @@ nsc edit user [flags] --allow-pubsub strings add publish and subscribe permissions - comma separated list or option can be specified multiple times --allow-sub strings add subscribe permissions - comma separated list or option can be specified multiple times --bearer no connect challenge required for user - --conn-type strings set allowed connection types: LEAFNODE MQTT STANDARD WEBSOCKET LEAFNODE_WS MQTT_WS IN_PROCESS - comma separated list or option can be specified multiple times + --conn-type strings set allowed connection types: LEAFNODE MQTT STANDARD WEBSOCKET LEAFNODE_WS MQTT_WS - comma separated list or option can be specified multiple times --data number set maximum data in bytes for the user (-1 is unlimited) (default -1) --deny-pub strings add deny publish permissions - comma separated list or option can be specified multiple times --deny-pubsub strings add deny publish and subscribe permissions - comma separated list or option can be specified multiple times --deny-sub strings add deny subscribe permissions - comma separated list or option can be specified multiple times - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -h, --help help for user --locale time-locale set the locale with which time values are interpreted -n, --name string user name @@ -69,7 +69,7 @@ nsc edit user [flags] --rm-tag strings remove tag - comma separated list or option can be specified multiple times --rm-time strings remove start-end time by start time "hh:mm:ss" (option can be specified multiple times) --source-network strings add source network for connection - comma separated list or option can be specified multiple times - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") --subs int set maximum number of subscriptions (-1 is unlimited) (default -1) --tag strings add tags for user - comma separated list or option can be specified multiple times --time time-ranges add start-end time range of the form "hh:mm:ss-hh:mm:ss" (option can be specified multiple times) (default []) @@ -78,7 +78,6 @@ nsc edit user [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -92,4 +91,4 @@ nsc edit user [flags] * [nsc edit](nsc_edit.md) - Edit assets such as accounts, imports, and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_env.md b/docs/nsc_env.md index 8922dc2b..fe4257fe 100644 --- a/docs/nsc_env.md +++ b/docs/nsc_env.md @@ -2,6 +2,10 @@ Prints and manage the nsc environment +### Synopsis + +Prints and manage the nsc environment + ``` nsc env [flags] ``` @@ -24,7 +28,6 @@ env ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -38,4 +41,4 @@ env * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_expirations.md b/docs/nsc_expirations.md deleted file mode 100644 index 4aa2115c..00000000 --- a/docs/nsc_expirations.md +++ /dev/null @@ -1,45 +0,0 @@ -## nsc expirations - -Create a new expiration report - -``` -nsc expirations [flags] -``` - -### Examples - -``` -expirations --skip --within 1w (reports entities that are expiring within on week) -expirations --json --within 3M (reports in JSON all entities marking those expiring within a month) - -``` - -### Options - -``` - -h, --help help for expirations - --json print the expiration report in json format to stdout - --skip skip reporting entities that are not expired or expiring soon - -e, --within string print an expiration report for entities that expire within the specified duration. - Supported are YYYY-MM-DD for absolute, and relative of now - (m)inute, (h)our, (d)ay, (w)week, (M)onth, (y)ear expressions (default "1M") -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_export.md b/docs/nsc_export.md index 2d41b256..46240b23 100644 --- a/docs/nsc_export.md +++ b/docs/nsc_export.md @@ -2,6 +2,10 @@ Export assets such as nkeys +### Synopsis + +Export assets such as nkeys + ### Options ``` @@ -11,7 +15,6 @@ Export assets such as nkeys ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -26,4 +29,4 @@ Export assets such as nkeys * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. * [nsc export keys](nsc_export_keys.md) - Export operator, account and user keys in the current operator and account context -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_export_keys.md b/docs/nsc_export_keys.md index 79ca9781..6c00b50e 100644 --- a/docs/nsc_export_keys.md +++ b/docs/nsc_export_keys.md @@ -21,10 +21,6 @@ The --filter flag allows you to specify a few letters in a public key and export those keys that matching the filter (provided the key type matches --operator, --account, --user (or --all). -The --include-jwts flag will export the JWT configurations named by their identity key. -This allows you to export an entire configuration tree of operators, accounts, users -and their keys to a directory. To recreate an environment from this export use 'nsc fix'. - ``` nsc export keys [flags] @@ -48,13 +44,10 @@ nsc export keys --account (changes the account context to the specified a --account string change account context to the named account -a, --accounts export account keys -A, --all export operator, accounts and users keys - --curve string export specified curve key - --curves export curve keys -d, --dir string directory to export keys to -f, --filter string export keys containing string -F, --force overwrite existing files -h, --help help for keys - --include-jwts include jwts --not-referenced export keys that are not referenced in the current operator context -o, --operator export operator keys -R, --remove removes the original key file from the keyring after exporting it @@ -65,7 +58,6 @@ nsc export keys --account (changes the account context to the specified a ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -79,4 +71,4 @@ nsc export keys --account (changes the account context to the specified a * [nsc export](nsc_export.md) - Export assets such as nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate.md b/docs/nsc_generate.md index 0ff7763d..5c4917c0 100644 --- a/docs/nsc_generate.md +++ b/docs/nsc_generate.md @@ -2,6 +2,10 @@ Generate activations, creds, configs or nkeys +### Synopsis + +Generate activations, creds, configs or nkeys + ### Options ``` @@ -11,7 +15,6 @@ Generate activations, creds, configs or nkeys ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -26,10 +29,8 @@ Generate activations, creds, configs or nkeys * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. * [nsc generate activation](nsc_generate_activation.md) - Generate an export activation jwt token * [nsc generate config](nsc_generate_config.md) - Generate an account config file for an operator -* [nsc generate context](nsc_generate_context.md) - Generate nats cli user context * [nsc generate creds](nsc_generate_creds.md) - Generate a credentials file for an user * [nsc generate diagram](nsc_generate_diagram.md) - Generate diagrams for this store * [nsc generate nkey](nsc_generate_nkey.md) - Generates an nkey -* [nsc generate profile](nsc_generate_profile.md) - Generate a profile from nsc 'URL' that can be used by tooling -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_activation.md b/docs/nsc_generate_activation.md index ac9054b3..90254ca6 100644 --- a/docs/nsc_generate_activation.md +++ b/docs/nsc_generate_activation.md @@ -2,6 +2,10 @@ Generate an export activation jwt token +### Synopsis + +Generate an export activation jwt token + ``` nsc generate activation [flags] ``` @@ -10,11 +14,11 @@ nsc generate activation [flags] ``` -a, --account string account name - --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --expiry string valid until ('0' is always, '2M' is two months) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -h, --help help for activation -o, --output-file string output file '--' is stdout (default "--") --push push activation token to operator's account server (exclusive of output-file - --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) + --start string valid from ('0' is always, '3d' is three days) - yyyy-mm-dd, #m(inutes), #h(ours), #d(ays), #w(eeks), #M(onths), #y(ears) (default "0") -s, --subject string export subject -t, --target-account string target-account ``` @@ -22,7 +26,6 @@ nsc generate activation [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -36,4 +39,4 @@ nsc generate activation [flags] * [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_config.md b/docs/nsc_generate_config.md index dafd3b5f..66c5455e 100644 --- a/docs/nsc_generate_config.md +++ b/docs/nsc_generate_config.md @@ -2,6 +2,10 @@ Generate an account config file for an operator +### Synopsis + +Generate an account config file for an operator + ``` nsc generate config [flags] ``` @@ -32,7 +36,6 @@ nsc generate config --nats-resolver-cache ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -46,4 +49,4 @@ nsc generate config --nats-resolver-cache * [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_context.md b/docs/nsc_generate_context.md deleted file mode 100644 index cea9fd0c..00000000 --- a/docs/nsc_generate_context.md +++ /dev/null @@ -1,41 +0,0 @@ -## nsc generate context - -Generate nats cli user context - -``` -nsc generate context [flags] -``` - -### Examples - -``` -nsc generate context --account a --user u --context contextName -``` - -### Options - -``` - -a, --account string account name - --context string context name - -h, --help help for context - -u, --user string user name -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_generate_creds.md b/docs/nsc_generate_creds.md index a2138b71..d59a51c5 100644 --- a/docs/nsc_generate_creds.md +++ b/docs/nsc_generate_creds.md @@ -2,6 +2,10 @@ Generate a credentials file for an user +### Synopsis + +Generate a credentials file for an user + ``` nsc generate creds [flags] ``` @@ -24,7 +28,6 @@ nsc generate creds --account a --name u ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -38,4 +41,4 @@ nsc generate creds --account a --name u * [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_diagram.md b/docs/nsc_generate_diagram.md index 20292028..8edf8712 100644 --- a/docs/nsc_generate_diagram.md +++ b/docs/nsc_generate_diagram.md @@ -2,6 +2,10 @@ Generate diagrams for this store +### Synopsis + +Generate diagrams for this store + ### Options ``` @@ -12,7 +16,6 @@ Generate diagrams for this store ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -28,4 +31,4 @@ Generate diagrams for this store * [nsc generate diagram component](nsc_generate_diagram_component.md) - Generate a plantuml component diagram for this store * [nsc generate diagram object](nsc_generate_diagram_object.md) - Generate a plantuml object diagram for this store -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_diagram_component.md b/docs/nsc_generate_diagram_component.md index 8c22d520..c8f26476 100644 --- a/docs/nsc_generate_diagram_component.md +++ b/docs/nsc_generate_diagram_component.md @@ -2,6 +2,10 @@ Generate a plantuml component diagram for this store +### Synopsis + +Generate a plantuml component diagram for this store + ``` nsc generate diagram component [flags] ``` @@ -22,7 +26,6 @@ nsc generate diagram component ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -37,4 +40,4 @@ nsc generate diagram component * [nsc generate diagram](nsc_generate_diagram.md) - Generate diagrams for this store -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_diagram_object.md b/docs/nsc_generate_diagram_object.md index cf8225f9..5ac0f93d 100644 --- a/docs/nsc_generate_diagram_object.md +++ b/docs/nsc_generate_diagram_object.md @@ -2,6 +2,10 @@ Generate a plantuml object diagram for this store +### Synopsis + +Generate a plantuml object diagram for this store + ``` nsc generate diagram object [flags] ``` @@ -24,7 +28,6 @@ nsc generate diagram object ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -39,4 +42,4 @@ nsc generate diagram object * [nsc generate diagram](nsc_generate_diagram.md) - Generate diagrams for this store -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_nkey.md b/docs/nsc_generate_nkey.md index 07921b0a..5f7029db 100644 --- a/docs/nsc_generate_nkey.md +++ b/docs/nsc_generate_nkey.md @@ -2,6 +2,10 @@ Generates an nkey +### Synopsis + +Generates an nkey + ``` nsc generate nkey [flags] ``` @@ -10,7 +14,6 @@ nsc generate nkey [flags] ``` -a, --account account - -x, --curve curve -h, --help help for nkey -o, --operator operator -S, --store store in the keystore @@ -20,7 +23,6 @@ nsc generate nkey [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -34,4 +36,4 @@ nsc generate nkey [flags] * [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_generate_profile.md b/docs/nsc_generate_profile.md deleted file mode 100644 index 94baca2b..00000000 --- a/docs/nsc_generate_profile.md +++ /dev/null @@ -1,85 +0,0 @@ -## nsc generate profile - -Generate a profile from nsc 'URL' that can be used by tooling - -``` -nsc generate profile [flags] -``` - -### Examples - -``` -profile nsc://operator -nsc profile nsc://operator/account -nsc profile nsc://operator/account/user -nsc profile nsc://operator/account/user?names&seeds&keys -nsc profile nsc://operator/account/user?operatorSeed&accountSeed&userSeed -nsc profile nsc://operator/account/user?operatorKey&accountKey&userKey -nsc profile nsc://operator?key&seed -nsc profile nsc://operator/account?key&seed -nsc profile nsc://operator/account/user?key&seed&name -nsc profile nsc://operator/account/user?store=/a/.nsc/nats&keystore=/foo/.nkeys - -Output of the program looks like: -{ - "user_creds": "", - "operator" : { - "service": "hostport" - } -} -The user_creds is printed if an user is specified -Other options (as query string arguments): -keystore= that specifies the location of the keystore - -store= that specifies a directory that contains the named operator - -[user|account|operator]Key - includes the public key for user, account, -operator, If no prefix (user/account/operator is provided, it targets -the last object in the configuration path) - -keys - includes the public keys for all entities (same as -userKey&accountKey&operatorKey) - -[user|account|operator]Seed= - include the seed for -user, account, operator, if an argument is provided, the seed for the -specified public key is provided - this allows targeting a signing key. -If no prefix (user/account/operator is provided, it targets the last -object in the configuration path) - -seeds - includes the private keys for all entities (same as -userSeed&accountSeed&operatorSeed) - -[user|account|operator]Name - includes the friendly name for the for -user, account, operator, If no prefix (user/account/operator is provided, -it targets the last object in the configuration path) - -names - includes the friendly names for all the entities (same as -userName&accountName&operatorName) - -``` - -### Options - -``` - -h, --help help for profile - -o, --output-file string output file, '--' is stdout (default "--") -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc generate](nsc_generate.md) - Generate activations, creds, configs or nkeys - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_import.md b/docs/nsc_import.md index bd1311bd..b38f61c7 100644 --- a/docs/nsc_import.md +++ b/docs/nsc_import.md @@ -2,6 +2,10 @@ Import assets such as nkeys +### Synopsis + +Import assets such as nkeys + ### Options ``` @@ -11,7 +15,6 @@ Import assets such as nkeys ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -28,4 +31,4 @@ Import assets such as nkeys * [nsc import keys](nsc_import_keys.md) - Imports all nkeys found in a directory * [nsc import user](nsc_import_user.md) - Imports an user from a jwt or user and nkey from a creds file -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_import_account.md b/docs/nsc_import_account.md index 48fe7660..46fbe98a 100644 --- a/docs/nsc_import_account.md +++ b/docs/nsc_import_account.md @@ -2,6 +2,10 @@ Imports an account from a jwt file and resign with operator if self signed +### Synopsis + +Imports an account from a jwt file and resign with operator if self signed + ``` nsc import account --file [flags] ``` @@ -25,7 +29,6 @@ nsc import account --file ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -39,4 +42,4 @@ nsc import account --file * [nsc import](nsc_import.md) - Import assets such as nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_import_keys.md b/docs/nsc_import_keys.md index 22d6583f..fc8eafe5 100644 --- a/docs/nsc_import_keys.md +++ b/docs/nsc_import_keys.md @@ -14,7 +14,7 @@ nsc import keys [flags] ``` nsc import keys --dir -nsc import keys --recurse --dir +nsc import keys --recursive --dir ``` @@ -29,7 +29,6 @@ nsc import keys --recurse --dir ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -43,4 +42,4 @@ nsc import keys --recurse --dir * [nsc import](nsc_import.md) - Import assets such as nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_import_user.md b/docs/nsc_import_user.md index dcf1d767..d6071cea 100644 --- a/docs/nsc_import_user.md +++ b/docs/nsc_import_user.md @@ -2,6 +2,10 @@ Imports an user from a jwt or user and nkey from a creds file +### Synopsis + +Imports an user from a jwt or user and nkey from a creds file + ``` nsc import user --file [flags] ``` @@ -24,7 +28,6 @@ nsc import user --file ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -38,4 +41,4 @@ nsc import user --file * [nsc import](nsc_import.md) - Import assets such as nkeys -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_init.md b/docs/nsc_init.md index daf0a031..b61eef52 100644 --- a/docs/nsc_init.md +++ b/docs/nsc_init.md @@ -2,6 +2,10 @@ Initialize an environment by creating an operator, account and user +### Synopsis + +Initialize an environment by creating an operator, account and user + ``` nsc init [flags] ``` @@ -9,23 +13,27 @@ nsc init [flags] ### Options ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -d, --dir string directory where the operator directory will be created (default "/home/runner/.local/share/nats/nsc/stores") + -d, --dir string directory where the operator directory will be created (default "/Users/synadia/.local/share/nats/nsc/stores") -h, --help help for init - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory -n, --name string name used for the operator, account and user - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -o, --remote-operator string remote well-known operator -u, --url string operator account server url ``` +### Options inherited from parent commands + +``` + --config-dir string nsc config directory + --data-dir string nsc data store directory + -i, --interactive ask questions for various settings + --keystore-dir string nsc keystore directory + -K, --private-key string Key used to sign. Can be specified as role (where applicable), + public key (private portion is retrieved) + or file path to a private key or private key +``` + ### SEE ALSO * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_keys.md b/docs/nsc_keys.md index a104f602..70fb2eed 100644 --- a/docs/nsc_keys.md +++ b/docs/nsc_keys.md @@ -2,6 +2,10 @@ Manage keys for operators, accounts, and users +### Synopsis + +Manage keys for operators, accounts, and users + ### Options ``` @@ -11,7 +15,6 @@ Manage keys for operators, accounts, and users ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -26,4 +29,4 @@ Manage keys for operators, accounts, and users * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. * [nsc keys migrate](nsc_keys_migrate.md) - migrates keystore to new layout, original keystore is preserved -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_keys_migrate.md b/docs/nsc_keys_migrate.md index 0a7e56b3..42f1d76c 100644 --- a/docs/nsc_keys_migrate.md +++ b/docs/nsc_keys_migrate.md @@ -2,6 +2,10 @@ migrates keystore to new layout, original keystore is preserved +### Synopsis + +migrates keystore to new layout, original keystore is preserved + ``` nsc keys migrate [flags] ``` @@ -15,7 +19,6 @@ nsc keys migrate [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -29,4 +32,4 @@ nsc keys migrate [flags] * [nsc keys](nsc_keys.md) - Manage keys for operators, accounts, and users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_list.md b/docs/nsc_list.md index fad481b1..510adb7f 100644 --- a/docs/nsc_list.md +++ b/docs/nsc_list.md @@ -2,6 +2,10 @@ List assets such as accounts, imports, users +### Synopsis + +List assets such as accounts, imports, users + ### Options ``` @@ -11,7 +15,6 @@ List assets such as accounts, imports, users ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -29,4 +32,4 @@ List assets such as accounts, imports, users * [nsc list operators](nsc_list_operators.md) - List operators * [nsc list users](nsc_list_users.md) - List users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_list_accounts.md b/docs/nsc_list_accounts.md index c38885da..6cf72bbc 100644 --- a/docs/nsc_list_accounts.md +++ b/docs/nsc_list_accounts.md @@ -2,6 +2,10 @@ List accounts +### Synopsis + +List accounts + ``` nsc list accounts [flags] ``` @@ -16,7 +20,6 @@ nsc list accounts [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -30,4 +33,4 @@ nsc list accounts [flags] * [nsc list](nsc_list.md) - List assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_list_keys.md b/docs/nsc_list_keys.md index a3cdf271..bce1b6b7 100644 --- a/docs/nsc_list_keys.md +++ b/docs/nsc_list_keys.md @@ -42,7 +42,6 @@ nsc list keys --account A (changes the account context to the specified account) --account string show specified account keys -a, --accounts show account keys -A, --all show operator, accounts and users - -x, --curve show curve keys -f, --filter string filter keys containing string -h, --help help for keys --not-referenced shows keys that are not referenced in the current operator context @@ -55,7 +54,6 @@ nsc list keys --account A (changes the account context to the specified account) ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -69,4 +67,4 @@ nsc list keys --account A (changes the account context to the specified account) * [nsc list](nsc_list.md) - List assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_list_operators.md b/docs/nsc_list_operators.md index db2ab474..fc04d8b3 100644 --- a/docs/nsc_list_operators.md +++ b/docs/nsc_list_operators.md @@ -2,6 +2,10 @@ List operators +### Synopsis + +List operators + ``` nsc list operators [flags] ``` @@ -15,7 +19,6 @@ nsc list operators [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -29,4 +32,4 @@ nsc list operators [flags] * [nsc list](nsc_list.md) - List assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_list_users.md b/docs/nsc_list_users.md index 45a76578..632be1d3 100644 --- a/docs/nsc_list_users.md +++ b/docs/nsc_list_users.md @@ -2,6 +2,10 @@ List users +### Synopsis + +List users + ``` nsc list users [flags] ``` @@ -17,7 +21,6 @@ nsc list users [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -31,4 +34,4 @@ nsc list users [flags] * [nsc list](nsc_list.md) - List assets such as accounts, imports, users -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_load.md b/docs/nsc_load.md deleted file mode 100644 index 940af126..00000000 --- a/docs/nsc_load.md +++ /dev/null @@ -1,36 +0,0 @@ -## nsc load - -install entities for an operator, account and key - -``` -nsc load [flags] -``` - -### Options - -``` - -h, --help help for load - --profile string Profile URL to initialize NSC and NATS CLI env - --seed string Seed of the account used to create users - --url string URL of the account server - --user string Default username (default "default") -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_pull.md b/docs/nsc_pull.md index e242f51b..42c91e82 100644 --- a/docs/nsc_pull.md +++ b/docs/nsc_pull.md @@ -2,6 +2,10 @@ Pull an operator or account jwt replacing the local jwt with the server's version +### Synopsis + +Pull an operator or account jwt replacing the local jwt with the server's version + ``` nsc pull [flags] ``` @@ -20,7 +24,6 @@ nsc pull [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -34,4 +37,4 @@ nsc pull [flags] * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_push.md b/docs/nsc_push.md index af8d25be..0ff84c26 100644 --- a/docs/nsc_push.md +++ b/docs/nsc_push.md @@ -2,6 +2,10 @@ Push an account jwt to an Account JWT Server +### Synopsis + +Push an account jwt to an Account JWT Server + ``` nsc push (currentAccount) push -a @@ -29,13 +33,11 @@ push -P, --prune prune all accounts not under the current operator. Only works with nats-resolver enabled nats-server. Mutually exclusive of account-removal/diff. --system-account string System account for use with nats-resolver enabled nats-server. (Default is system account specified by operator) --system-user string System account user for use with nats-resolver enabled nats-server. (Default to temporarily generated user) - --timeout int timeout in seconds [1-60] to wait for responses from the server (only applicable to nats-resolver configurations, and applies per operation) (default 1) ``` ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -49,4 +51,4 @@ push * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_reissue.md b/docs/nsc_reissue.md index 73343e0d..dd4f1d50 100644 --- a/docs/nsc_reissue.md +++ b/docs/nsc_reissue.md @@ -2,6 +2,10 @@ Re-issue objects with a new identity key +### Synopsis + +Re-issue objects with a new identity key + ### Options ``` @@ -11,7 +15,6 @@ Re-issue objects with a new identity key ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -24,10 +27,6 @@ Re-issue objects with a new identity key ### SEE ALSO * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -* [nsc reissue operator](nsc_reissue_operator.md) - Re-issues the operator with a new identity and re-signs affected accounts. - When `--private-key` flag is provided with an operator seed, the identity - specified will be used for the operator and as the issuer for the accounts. - Note use of this command could create a disruption. Please backup your server - and nsc environment prior to use. +* [nsc reissue operator](nsc_reissue_operator.md) - Re-issues the operator with a new identity and re-signs affected accounts -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_reissue_operator.md b/docs/nsc_reissue_operator.md index 01dcb5d6..16d08234 100644 --- a/docs/nsc_reissue_operator.md +++ b/docs/nsc_reissue_operator.md @@ -1,10 +1,10 @@ ## nsc reissue operator -Re-issues the operator with a new identity and re-signs affected accounts. - When `--private-key` flag is provided with an operator seed, the identity - specified will be used for the operator and as the issuer for the accounts. - Note use of this command could create a disruption. Please backup your server - and nsc environment prior to use. +Re-issues the operator with a new identity and re-signs affected accounts + +### Synopsis + +Re-issues the operator with a new identity and re-signs affected accounts ``` nsc reissue operator [flags] @@ -27,7 +27,6 @@ nsc reissue operator ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +40,4 @@ nsc reissue operator * [nsc reissue](nsc_reissue.md) - Re-issue objects with a new identity key -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations.md b/docs/nsc_revocations.md index 3746b51b..f1252048 100644 --- a/docs/nsc_revocations.md +++ b/docs/nsc_revocations.md @@ -2,6 +2,10 @@ Manage revocation for users and activations from an account +### Synopsis + +Manage revocation for users and activations from an account + ### Options ``` @@ -11,7 +15,6 @@ Manage revocation for users and activations from an account ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -31,4 +34,4 @@ Manage revocation for users and activations from an account * [nsc revocations list-users](nsc_revocations_list-users.md) - List users revoked in an account * [nsc revocations list_activations](nsc_revocations_list_activations.md) - List account revocations for an export -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations_add-user.md b/docs/nsc_revocations_add-user.md index 21a587b7..9b5e45d2 100644 --- a/docs/nsc_revocations_add-user.md +++ b/docs/nsc_revocations_add-user.md @@ -2,6 +2,10 @@ Revoke a user +### Synopsis + +Revoke a user + ``` nsc revocations add-user [flags] ``` @@ -10,7 +14,7 @@ nsc revocations add-user [flags] ``` -a, --account string account name - --at date-time revokes all user credentials created or edited before a Unix timestamp ('0' is treated as now, accepted formats are RFC3339 or #seconds since epoch) (default 1970-01-01T00:00:00Z) + --at date-time revokes all user credentials created or edited before a Unix timestamp ('0' is treated as now, accepted formats are RFC3339 or #seconds since epoch) (default 1969-12-31T18:00:00-06:00) -h, --help help for add-user -n, --name string user name -u, --user-public-key string user-public-key @@ -19,7 +23,6 @@ nsc revocations add-user [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -33,4 +36,4 @@ nsc revocations add-user [flags] * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations_add_activation.md b/docs/nsc_revocations_add_activation.md index 7a96e942..313780ae 100644 --- a/docs/nsc_revocations_add_activation.md +++ b/docs/nsc_revocations_add_activation.md @@ -2,6 +2,10 @@ Revoke an accounts access to an export +### Synopsis + +Revoke an accounts access to an export + ``` nsc revocations add_activation [flags] ``` @@ -10,7 +14,7 @@ nsc revocations add_activation [flags] ``` -a, --account string account name - --at date-time revokes all activations for an account created or edited before a Unix timestamp ('0' is treated as now, accepted formats are RFC3339 or #seconds since epoch) (default 1970-01-01T00:00:00Z) + --at date-time revokes all activations for an account created or edited before a Unix timestamp ('0' is treated as now, accepted formats are RFC3339 or #seconds since epoch) (default 1969-12-31T18:00:00-06:00) -h, --help help for add_activation --service service -s, --subject string export subject @@ -20,7 +24,6 @@ nsc revocations add_activation [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -34,4 +37,4 @@ nsc revocations add_activation [flags] * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations_delete-user.md b/docs/nsc_revocations_delete-user.md index ae0e58c7..b000243b 100644 --- a/docs/nsc_revocations_delete-user.md +++ b/docs/nsc_revocations_delete-user.md @@ -2,6 +2,10 @@ Remove a user revocation +### Synopsis + +Remove a user revocation + ``` nsc revocations delete-user [flags] ``` @@ -18,7 +22,6 @@ nsc revocations delete-user [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -32,4 +35,4 @@ nsc revocations delete-user [flags] * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations_delete_activation.md b/docs/nsc_revocations_delete_activation.md index 6b114d25..b58fb73c 100644 --- a/docs/nsc_revocations_delete_activation.md +++ b/docs/nsc_revocations_delete_activation.md @@ -2,6 +2,10 @@ Remove an account revocation from an export +### Synopsis + +Remove an account revocation from an export + ``` nsc revocations delete_activation [flags] ``` @@ -19,7 +23,6 @@ nsc revocations delete_activation [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -33,4 +36,4 @@ nsc revocations delete_activation [flags] * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations_list-users.md b/docs/nsc_revocations_list-users.md index 1970eab7..2d9d9ac3 100644 --- a/docs/nsc_revocations_list-users.md +++ b/docs/nsc_revocations_list-users.md @@ -2,6 +2,10 @@ List users revoked in an account +### Synopsis + +List users revoked in an account + ``` nsc revocations list-users [flags] ``` @@ -16,7 +20,6 @@ nsc revocations list-users [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -30,4 +33,4 @@ nsc revocations list-users [flags] * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_revocations_list_activations.md b/docs/nsc_revocations_list_activations.md index 4989d2ba..217041a6 100644 --- a/docs/nsc_revocations_list_activations.md +++ b/docs/nsc_revocations_list_activations.md @@ -2,6 +2,10 @@ List account revocations for an export +### Synopsis + +List account revocations for an export + ``` nsc revocations list_activations [flags] ``` @@ -18,7 +22,6 @@ nsc revocations list_activations [flags] ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -32,4 +35,4 @@ nsc revocations list_activations [flags] * [nsc revocations](nsc_revocations.md) - Manage revocation for users and activations from an account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_select.md b/docs/nsc_select.md deleted file mode 100644 index c6b7b1a0..00000000 --- a/docs/nsc_select.md +++ /dev/null @@ -1,30 +0,0 @@ -## nsc select - -Set the current operator or account - -### Options - -``` - -h, --help help for select -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -* [nsc select account](nsc_select_account.md) - set the account -* [nsc select operator](nsc_select_operator.md) - set the operator - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_select_account.md b/docs/nsc_select_account.md deleted file mode 100644 index 2e10a43d..00000000 --- a/docs/nsc_select_account.md +++ /dev/null @@ -1,32 +0,0 @@ -## nsc select account - -set the account - -``` -nsc select account [flags] -``` - -### Options - -``` - -h, --help help for account -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc select](nsc_select.md) - Set the current operator or account - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_select_operator.md b/docs/nsc_select_operator.md deleted file mode 100644 index 68318ad0..00000000 --- a/docs/nsc_select_operator.md +++ /dev/null @@ -1,32 +0,0 @@ -## nsc select operator - -set the operator - -``` -nsc select operator [flags] -``` - -### Options - -``` - -h, --help help for operator -``` - -### Options inherited from parent commands - -``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value - --config-dir string nsc config directory - --data-dir string nsc data store directory - -i, --interactive ask questions for various settings - --keystore-dir string nsc keystore directory - -K, --private-key string Key used to sign. Can be specified as role (where applicable), - public key (private portion is retrieved) - or file path to a private key or private key -``` - -### SEE ALSO - -* [nsc select](nsc_select.md) - Set the current operator or account - -###### Auto generated by spf13/cobra on 18-Dec-2024 diff --git a/docs/nsc_tool.md b/docs/nsc_tool.md index d347d388..349f3ce8 100644 --- a/docs/nsc_tool.md +++ b/docs/nsc_tool.md @@ -2,6 +2,10 @@ NATS tools: pub, sub, req, rep, rtt +### Synopsis + +NATS tools: pub, sub, req, rep, rtt + ### Options ``` @@ -12,7 +16,6 @@ NATS tools: pub, sub, req, rep, rtt ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -31,4 +34,4 @@ NATS tools: pub, sub, req, rep, rtt * [nsc tool rtt](nsc_tool_rtt.md) - Calculate the round trip time to the server * [nsc tool sub](nsc_tool_sub.md) - Subscribe to a subject on a NATS account -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_tool_pub.md b/docs/nsc_tool_pub.md index 43a5e283..00b6646b 100644 --- a/docs/nsc_tool_pub.md +++ b/docs/nsc_tool_pub.md @@ -2,6 +2,10 @@ Publish to a subject from a NATS account +### Synopsis + +Publish to a subject from a NATS account + ``` nsc tool pub [flags] ``` @@ -23,7 +27,6 @@ nsc tool pub ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -38,4 +41,4 @@ nsc tool pub * [nsc tool](nsc_tool.md) - NATS tools: pub, sub, req, rep, rtt -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_tool_reply.md b/docs/nsc_tool_reply.md index bd59d136..efc1c287 100644 --- a/docs/nsc_tool_reply.md +++ b/docs/nsc_tool_reply.md @@ -2,6 +2,10 @@ Reply to requests on a subject on a NATS account +### Synopsis + +Reply to requests on a subject on a NATS account + ``` nsc tool reply [flags] ``` @@ -26,7 +30,6 @@ nsc tool reply --queue subject ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +44,4 @@ nsc tool reply --queue subject * [nsc tool](nsc_tool.md) - NATS tools: pub, sub, req, rep, rtt -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_tool_req.md b/docs/nsc_tool_req.md index c7c6f6bf..14e5dbec 100644 --- a/docs/nsc_tool_req.md +++ b/docs/nsc_tool_req.md @@ -2,6 +2,10 @@ Send a request to a subject on a NATS account +### Synopsis + +Send a request to a subject on a NATS account + ``` nsc tool req [flags] ``` @@ -23,7 +27,6 @@ ngs tool req ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -38,4 +41,4 @@ ngs tool req * [nsc tool](nsc_tool.md) - NATS tools: pub, sub, req, rep, rtt -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_tool_rtt.md b/docs/nsc_tool_rtt.md index fcbaeef9..f7a48912 100644 --- a/docs/nsc_tool_rtt.md +++ b/docs/nsc_tool_rtt.md @@ -2,6 +2,10 @@ Calculate the round trip time to the server +### Synopsis + +Calculate the round trip time to the server + ``` nsc tool rtt [flags] ``` @@ -23,7 +27,6 @@ nsc tool rtt ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -38,4 +41,4 @@ nsc tool rtt * [nsc tool](nsc_tool.md) - NATS tools: pub, sub, req, rep, rtt -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_tool_sub.md b/docs/nsc_tool_sub.md index e8e77284..b8a5d407 100644 --- a/docs/nsc_tool_sub.md +++ b/docs/nsc_tool_sub.md @@ -2,6 +2,10 @@ Subscribe to a subject on a NATS account +### Synopsis + +Subscribe to a subject on a NATS account + ``` nsc tool sub [flags] ``` @@ -26,7 +30,6 @@ nsc tool --queue subject ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +44,4 @@ nsc tool --queue subject * [nsc tool](nsc_tool.md) - NATS tools: pub, sub, req, rep, rtt -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_update.md b/docs/nsc_update.md index dc457e93..fdf6bb37 100644 --- a/docs/nsc_update.md +++ b/docs/nsc_update.md @@ -2,6 +2,10 @@ Update this tool to latest version +### Synopsis + +Update this tool to latest version + ``` nsc update [flags] ``` @@ -22,7 +26,6 @@ nsc update ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -36,4 +39,4 @@ nsc update * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022 diff --git a/docs/nsc_validate.md b/docs/nsc_validate.md index c2deeeb0..1c16138a 100644 --- a/docs/nsc_validate.md +++ b/docs/nsc_validate.md @@ -2,6 +2,10 @@ Validate an operator, account(s), and users +### Synopsis + +Validate an operator, account(s), and users + ``` nsc validate (current operator/current account/account users) validate -a (current operator//account users) @@ -27,7 +31,6 @@ validate ### Options inherited from parent commands ``` - -H, --all-dirs string sets --config-dir, --data-dir, and --keystore-dir to the same value --config-dir string nsc config directory --data-dir string nsc data store directory -i, --interactive ask questions for various settings @@ -41,4 +44,4 @@ validate * [nsc](nsc.md) - nsc creates NATS operators, accounts, users, and manage their permissions. -###### Auto generated by spf13/cobra on 18-Dec-2024 +###### Auto generated by spf13/cobra on 25-Feb-2022