Skip to content

Commit 795d0ff

Browse files
committed
fix: align help paths with cortex home
1 parent 7954d02 commit 795d0ff

2 files changed

Lines changed: 52 additions & 4 deletions

File tree

src/cortex-cli/src/cli/styles.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,17 @@ pub const AFTER_HELP: &str = color_print::cstr!(
3535
<green,bold>cortex resume --last</> Continue most recent session
3636
3737
<cyan,bold>🌍 ENVIRONMENT VARIABLES</>
38-
<yellow>CORTEX_HOME</> Override config directory (default: ~/.config/cortex)
38+
<yellow>CORTEX_HOME</> Override Cortex home directory (default: ~/.cortex)
3939
<yellow>CORTEX_API_KEY</> API key (alternative to --with-api-key)
4040
<yellow>CORTEX_MODEL</> Default model (alternative to --model)
4141
<yellow>CORTEX_LOG_LEVEL</> Log verbosity (error, warn, info, debug, trace)
4242
<yellow>NO_COLOR</> Disable colored output (set to '1' or 'true')
4343
<yellow>VISUAL</>/<yellow>EDITOR</> Editor for /edit command
4444
4545
<cyan,bold>📁 PATHS</>
46-
<dim>Config</> ~/.config/cortex/config.toml
47-
<dim>Sessions</> ~/.local/share/cortex/sessions/
48-
<dim>Logs</> ~/.cache/cortex/logs/
46+
<dim>Config</> ~/.cortex/config.toml
47+
<dim>Sessions</> ~/.cortex/sessions/
48+
<dim>Logs</> ~/.cortex/logs/
4949
<dim>Agents</> ~/.cortex/agents/ (personal), .cortex/agents/ (project)
5050
5151
<cyan,bold>🔗 LEARN MORE</>

src/cortex-cli/tests/help_paths.rs

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
use std::process::Command;
2+
3+
#[test]
4+
fn root_help_documents_canonical_cortex_home_paths() {
5+
let output = Command::new(env!("CARGO_BIN_EXE_Cortex"))
6+
.arg("--help")
7+
.env("NO_COLOR", "1")
8+
.output()
9+
.expect("failed to run Cortex --help");
10+
11+
assert!(
12+
output.status.success(),
13+
"Cortex --help failed: stdout=\n{}\nstderr=\n{}",
14+
String::from_utf8_lossy(&output.stdout),
15+
String::from_utf8_lossy(&output.stderr)
16+
);
17+
18+
let stdout = String::from_utf8_lossy(&output.stdout);
19+
20+
assert!(
21+
stdout.contains("default: ~/.cortex"),
22+
"CORTEX_HOME help should document the canonical ~/.cortex default:\n{stdout}"
23+
);
24+
assert!(
25+
stdout.contains("~/.cortex/config.toml"),
26+
"Config path should use canonical Cortex home:\n{stdout}"
27+
);
28+
assert!(
29+
stdout.contains("~/.cortex/sessions/"),
30+
"Sessions path should use canonical Cortex home:\n{stdout}"
31+
);
32+
assert!(
33+
stdout.contains("~/.cortex/logs/"),
34+
"Logs path should use canonical Cortex home:\n{stdout}"
35+
);
36+
assert!(
37+
!stdout.contains("~/.config/cortex"),
38+
"Help should not advertise lowercase XDG config paths:\n{stdout}"
39+
);
40+
assert!(
41+
!stdout.contains("~/.local/share/cortex"),
42+
"Help should not advertise lowercase XDG data paths:\n{stdout}"
43+
);
44+
assert!(
45+
!stdout.contains("~/.cache/cortex"),
46+
"Help should not advertise lowercase XDG cache paths:\n{stdout}"
47+
);
48+
}

0 commit comments

Comments
 (0)