diff --git a/README.md b/README.md index f2f6507b..fffb692c 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,20 @@ Usage: Available Commands: completion Generate the autocompletion script for the specified shell + create-bookmark Creates a bookmark from JSON. + create-invite Create a new invite + end-change Finishes the specified change. Call this just after you finished the change. This will store a snapshot of the current system state for later reference. get-affected-bookmarks Calculates the bookmarks that would be overlapping with a snapshot. get-bookmark Displays the contents of a bookmark. + get-change Displays the contents of a change. get-snapshot Displays the contents of a snapshot. help Help about any command + list-changes Displays the contents of a change. + list-invites List all invites + manual-change Creates a new Change from a given query request Runs a request against the overmind API + revoke-invites Revoke an existing invite + start-change Starts the specified change. Call this just before you're about to start the change. This will store a snapshot of the current system state for later reference. submit-plan Creates a new Change from a given terraform plan file Flags: @@ -20,19 +29,19 @@ Flags: --api-key-url string The overmind API Keys endpoint (defaults to --url) --auth0-client-id string OAuth Client ID to use when connecting with auth (default "j3LylZtIosVPZtouKI8WuVHmE6Lluva1") --auth0-domain string Auth0 domain to connect to (default "om-prod.eu.auth0.com") - --config string config file (default is redacted.yaml) --gateway-url string The overmind Gateway endpoint (defaults to /api/gateway on --url) -h, --help help for ovm-cli - --honeycomb-api-key string If specified, configures opentelemetry libraries to submit traces to honeycomb - --json-log Set to true to emit logs as json for easier parsing + --honeycomb-api-key string If specified, configures opentelemetry libraries to submit traces to honeycomb. This requires --otel to be set. + --json-log Set to true to emit logs as json for easier parsing. --log string Set the log level. Valid values: panic, fatal, error, warn, info, debug, trace (default "info") + --otel If specified, configures opentelemetry and - optionally, see --sentry-dsn - sentry using their default environment configs. --run-mode string Set the run mode for this service, 'release', 'debug' or 'test'. Defaults to 'release'. (default "release") - --sentry-dsn string If specified, configures sentry libraries to capture errors - --stdout-trace-dump Dump all otel traces to stdout for debugging + --sentry-dsn string If specified, configures sentry libraries to capture errors. This requires --otel to be set. + --stdout-trace-dump Dump all otel traces to stdout for debugging. This requires --otel to be set. --url string The overmind API endpoint (default "https://api.prod.overmind.tech") -v, --version version for ovm-cli -Use "ovm-cli [command] --help" for more information about a command. +Use "ovm-cli [command] --help" for more information about a command.``` ``` ## Examples