Skip to content

Commit 1ab6d37

Browse files
TheGreatAxiosTheGreatAxios
committed
feat(cli): add --version and -V flags
1 parent 7876b56 commit 1ab6d37

5 files changed

Lines changed: 105 additions & 4 deletions

File tree

‎docs/IMPLEMENTATION.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,7 @@ This release changes no settings, OAuth-store, or session persistence format and
404404

405405
Printed by `corbits --help` / `-h` from `CLI_HELP_TEXT` in `src/config/index.ts`
406406
(that constant is the source of truth; keep this table in sync when flags change).
407+
`--version` / `-V` print `CLI_VERSION_TEXT` (the `package.json` version) and exit 0.
407408

408409
| Verb / Flag | Default | Description |
409410
| ------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -424,6 +425,7 @@ Printed by `corbits --help` / `-h` from `CLI_HELP_TEXT` in `src/config/index.ts`
424425
| `--auto` | true (default) | Force auto mode on (workspace writes + unconstrained shell without prompts) |
425426
| `--no-auto` | false | Start with auto mode off (ask on every consequential action); no in-session key toggles it |
426427
| `--help`, `-h` | — | Show help (exit 0 via `CliHelpError`) |
428+
| `--version`, `-V` | — | Print the running `package.json` version (exit 0 via `CliVersionError`) |
427429

428430
Positional arguments after flags are joined into the optional initial task delivered when the TUI mounts. With no positional task, the operator starts from an empty prompt.
429431

‎src/config.test.ts‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ import {
2020
catalogEntryAsProviderSettings,
2121
CliHelpError,
2222
CliUserError,
23+
CliVersionError,
2324
CLI_HELP_TEXT,
25+
CLI_VERSION_TEXT,
2426
KEYLESS_API_KEY,
2527
loadConfig,
2628
providerCatalogToSettings,
@@ -30,6 +32,7 @@ import {
3032
SOURCE_MAX_TOKENS,
3133
} from "./config/index.js";
3234
import { DIRECTOR_IDS } from "./agent/directors/types.js";
35+
import pkg from "../package.json" with { type: "json" };
3336
import {
3437
clearSourceCredentials,
3538
peekSourceCredentialSecret,
@@ -200,6 +203,19 @@ async function expectCliHelp(argv: readonly string[]): Promise<void> {
200203
}
201204
}
202205

206+
async function expectCliVersion(argv: readonly string[]): Promise<void> {
207+
try {
208+
await loadConfig([...argv], { globalSettingsPath: NO_SETTINGS });
209+
expect.unreachable("expected CliVersionError");
210+
} catch (err) {
211+
expect(err).toBeInstanceOf(CliVersionError);
212+
const version = err as CliVersionError;
213+
expect(version.exitCode).toBe(0);
214+
expect(version.message).toBe(CLI_VERSION_TEXT);
215+
expect(version.message).toBe(pkg.version);
216+
}
217+
}
218+
203219
describe("loadConfig", () => {
204220
test("resolves provider from the global settings file", async () => {
205221
const cwd = await emptyCwd();
@@ -951,6 +967,54 @@ describe("loadConfig", () => {
951967
},
952968
);
953969

970+
test("CLI_HELP_TEXT documents --version and -V", () => {
971+
expect(CLI_HELP_TEXT).toContain("--version, -V");
972+
});
973+
974+
test.each([
975+
[["--version"]],
976+
[["-V"]],
977+
[["--auto", "--version"]],
978+
[["--auto", "-V"]],
979+
[["ship it", "--version"]],
980+
[["ship", "it", "--version"]],
981+
[["--cwd", ".", "--version"]],
982+
[["--provider", "fireworks", "--version"]],
983+
[["exec", "--version"]],
984+
[["exec", "--director", "--version"]],
985+
[["resume", "--pick", "--version"]],
986+
[["resume", "-V"]],
987+
[["resume", "--version"]],
988+
[["continue", "-V"]],
989+
// Value flags must not swallow --version / -V as their value.
990+
[["--provider", "--version"]],
991+
[["--provider", "-V"]],
992+
[["--model", "--version"]],
993+
[["--model", "-V"]],
994+
[["--cwd", "--version"]],
995+
[["--cwd", "-V"]],
996+
[["--config", "--version"]],
997+
[["--config", "-V"]],
998+
[["--profile", "--version"]],
999+
[["--profile", "-V"]],
1000+
])(
1001+
"%j throws CliVersionError with exitCode 0 and package version",
1002+
async (argv) => {
1003+
await expectCliVersion(argv);
1004+
},
1005+
);
1006+
1007+
test.each([
1008+
[["--version", "--help"]],
1009+
[["-V", "-h"]],
1010+
[["--help", "--version"]],
1011+
])(
1012+
"%j prefers CliHelpError when help and version are both present",
1013+
async (argv) => {
1014+
await expectCliHelp(argv);
1015+
},
1016+
);
1017+
9541018
test.each([
9551019
// Other flag-shaped tokens are not accepted as values.
9561020
[["--provider", "--auto"], "--provider requires a value"],

‎src/config/index.ts‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
} from "../session/index.js";
1010
import { loadState } from "../session/state.js";
1111
import { COMMAND_NAME } from "../branding.js";
12+
import pkg from "../../package.json" with { type: "json" };
1213

1314
import { isDirectorId } from "../agent/directors/registry.js";
1415
import { DIRECTOR_IDS, type DirectorId } from "../agent/directors/types.js";
@@ -729,6 +730,7 @@ Flags:
729730
--config selects another source
730731
--auto / --no-auto auto mode on/off
731732
--help, -h show this help
733+
--version, -V print version
732734
`;
733735

734736
/**
@@ -744,6 +746,23 @@ export class CliHelpError extends Error {
744746
}
745747
}
746748

749+
/** Printed for `corbits --version` / `-V`. Matches `package.json` version. */
750+
export const CLI_VERSION_TEXT =
751+
typeof pkg.version === "string" ? pkg.version : "0.0.0";
752+
753+
/**
754+
* Thrown when the operator asked for the CLI version. Entry points must print
755+
* `message` to stdout and exit 0 — not treat this as a crash.
756+
*/
757+
export class CliVersionError extends Error {
758+
readonly exitCode = 0 as const;
759+
760+
constructor(text: string = CLI_VERSION_TEXT) {
761+
super(text);
762+
this.name = "CliVersionError";
763+
}
764+
}
765+
747766
/**
748767
* Thrown for a recoverable operator mistake. Entry points must print
749768
* `message` to stderr and exit 1 — not dump a stack.
@@ -774,7 +793,7 @@ export interface LoadConfigOptions {
774793
}
775794

776795
function isFlagToken(arg: string): boolean {
777-
return arg.startsWith("--") || arg === "-h" || arg === "-p";
796+
return arg.startsWith("--") || arg === "-h" || arg === "-p" || arg === "-V";
778797
}
779798

780799
export async function loadConfig(
@@ -794,6 +813,9 @@ export async function loadConfig(
794813
if (argv.some((arg) => arg === "--help" || arg === "-h")) {
795814
throw new CliHelpError();
796815
}
816+
if (argv.some((arg) => arg === "--version" || arg === "-V")) {
817+
throw new CliVersionError();
818+
}
797819

798820
const args = [...argv];
799821

‎src/index.test.ts‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
33
import { tmpdir } from "node:os";
44
import { join } from "node:path";
55
import type { Config } from "./config/index.js";
6-
import { CliHelpError, CliUserError } from "./config/index.js";
6+
import { CliHelpError, CliUserError, CliVersionError } from "./config/index.js";
77
import {
88
resetPricingMetadataRefreshForTests,
99
schedulePricingMetadataRefresh,
@@ -171,6 +171,14 @@ test("CliHelpError prints help to stdout and exits 0", () => {
171171
expect(exit.text).toBe("usage: corbits\n");
172172
});
173173

174+
test("CliVersionError prints version to stdout and exits 0", () => {
175+
const err = new CliVersionError("1.2.3");
176+
const exit = cliCaughtExit(err);
177+
expect(exit.stream).toBe("stdout");
178+
expect(exit.code).toBe(0);
179+
expect(exit.text).toBe("1.2.3\n");
180+
});
181+
174182
test("generic Error still dumps a stack to stderr", () => {
175183
const err = new Error("No session abc for this project");
176184
const exit = cliCaughtExit(err);

‎src/index.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import { getLogger } from "@intx/log";
22
import { LOG_NAMESPACE_ROOT } from "./branding.js";
33
import { primeCrashReporting } from "./crash/report.js";
4-
import { loadConfig, CliHelpError, CliUserError } from "./config/index.js";
4+
import {
5+
loadConfig,
6+
CliHelpError,
7+
CliUserError,
8+
CliVersionError,
9+
} from "./config/index.js";
510
import {
611
ensureTelemetrySettings,
712
globalSettingsPath,
@@ -129,7 +134,7 @@ export function cliCaughtExit(err: unknown): {
129134
text: string;
130135
code: number;
131136
} {
132-
if (err instanceof CliHelpError) {
137+
if (err instanceof CliHelpError || err instanceof CliVersionError) {
133138
return { stream: "stdout", text: `${err.message}\n`, code: err.exitCode };
134139
}
135140
if (err instanceof CliUserError) {

0 commit comments

Comments
 (0)