Skip to content

docs(cli): document sudo cortex home precedence in --help #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
694410194 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(cli): document sudo cortex home precedence in --help #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/cortex-cli/src/cli/styles.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,15 @@ pub const AFTER_HELP: &str = color_print::cstr!(
<green,bold>cortex resume --last</> Continue most recent session

<cyan,bold>🌍 ENVIRONMENT VARIABLES</>
<yellow>CORTEX_HOME</> Override config directory (default: ~/.config/cortex)
<yellow>CORTEX_CONFIG_DIR</> Highest-priority Cortex home override
<yellow>CORTEX_HOME</> Override Cortex home directory
<yellow>CORTEX_API_KEY</> API key (alternative to --with-api-key)
<yellow>CORTEX_MODEL</> Default model (alternative to --model)
<yellow>CORTEX_LOG_LEVEL</> Log verbosity (error, warn, info, debug, trace)
<yellow>NO_COLOR</> Disable colored output (set to '1' or 'true')
<yellow>VISUAL</>/<yellow>EDITOR</> Editor for /edit command
<dim>sudo/root</> Under sudo, Cortex prefers SUDO_USER or SUDO_UID home resolution.
<dim> </> Bare root uses root's home; set CORTEX_HOME or CORTEX_CONFIG_DIR to override.

<cyan,bold>📁 PATHS</>
<dim>Config</> ~/.config/cortex/config.toml
Expand Down