diff --git a/docs/cody/clients/install-cli.mdx b/docs/cody/clients/install-cli.mdx index 32dee1062..37339860c 100644 --- a/docs/cody/clients/install-cli.mdx +++ b/docs/cody/clients/install-cli.mdx @@ -2,17 +2,15 @@

Learn how to install the cody command-line tool and using the cody chat subcommand.

- -Cody CLI support is in the experimental stage. + +Cody CLI support is in the Experimental stage for Enterprise accounts. Cody CLI is the same technology that powers the Cody IDE plugins but available from the command-line. Use Cody CLI for ad-hoc exploration in your terminal or as part of scripts to automate your workflows. -Cody CLI is available to Free, Pro, and Enterprise customers. - - + ## Prerequisites @@ -91,8 +89,9 @@ This will open a browser window where you can authenticate with your Sourcegraph Close the browser tab after authentication is complete. -- For Cody Pro/Free accounts, create an access token at https://sourcegraph.com/user/settings/tokens. -- For Cody Enterprise accounts, sign into your Sourcegraph Enterprise account and create an access token under `Account > Settings > Access Tokens`. + +- Cody Enterprise accounts can sign into their Sourcegraph Enterprise account and create an access token under `Account > Settings > Access Tokens`. +- ```shell export SRC_ENDPOINT=ENDPOINT export SRC_ACCESS_TOKEN=ACCESS_TOKEN @@ -114,7 +113,6 @@ cody auth whoami **Skip this step if you have already authenticated with the `cody auth login` command.** - If you prefer not to let Cody CLI store your access token, you can also pass the endpoint URL and access token through the environment variables `SRC_ENDPOINT` and `SRC_ACCESS_TOKEN`. @@ -132,7 +130,7 @@ $env:SRC_ACCESS_TOKEN = "ACCESS_TOKEN" -It's recommended to store these access tokens in a secure location. +It's recommended to store these access tokens in a secure location. For example, you can store them with a password manager like [1Password](https://1password.com/) or [Bitwarden](https://bitwarden.com/). It is not recommended to export these variables in your shell startup script because it will expose your access token to all commands you run from the terminal. Instead, consider sourcing these environment variables on-demand when you need to authenticate with the Cody CLI. @@ -209,6 +207,3 @@ Use the `-` trailing argument as an alternative to `--stdin` to read the diff fr ```shell git diff | cody chat -m 'Write a commit message for this diff' - ``` - - -