Skip to content

refactor(cli): give each command its own help screen #5181

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
orangeCatDeveloper wants to merge 1 commit into
base: main
Choose a base branch
from
+418 −136
Open

refactor(cli): give each command its own help screen #5181

Show file tree
Hide file tree
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
120 changes: 100 additions & 20 deletions packages/cli/src/__tests__/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,17 @@ describe('Maka CLI args', () => {
const help = parseMakaCliArgs(['--help'], '0.1.0');
assert.equal(help.kind, 'help');
if (help.kind !== 'help') return;
assert.match(help.text, /^ maka Start the TUI$/m);
assert.match(help.text, /^ {2}maka {2,}Start the TUI$/m);
assert.doesNotMatch(help.text, /maka-agent/);
assert.match(help.text, /^ maka run /m);
assert.match(help.text, /^ maka activate /m);
assert.match(help.text, /^ maka eval /m);
assert.match(help.text, /^ maka update --target /m);
assert.match(
help.text,
/^ maka --acp Serve ACP v1 over stdio \(initialize, session\/new, session\/list\)$/m,
);
assert.match(help.text, /^ maka runtime-host serve /m);
assert.match(help.text, /^ {2}maka run /m);
assert.match(help.text, /^ {2}maka activate /m);
assert.match(help.text, /^ {2}maka eval /m);
assert.match(help.text, /^ {2}maka update /m);
assert.match(help.text, /^ {2}maka --acp {2,}Serve ACP v1 over stdio /m);
// Runtime Host owns its own help; the root lists it once and points there.
assert.match(help.text, /^ {2}maka runtime-host \.\.\. {2,}Serve and manage a Runtime Host$/m);
assert.doesNotMatch(help.text, /^ {2}maka runtime-host (?:serve|service|access) /m);
assert.ok(help.text.split('\n').length < 30, 'the root help stays a single screen');
assert.doesNotMatch(help.text, /cli:dev/);
});

Expand Down Expand Up @@ -118,18 +118,27 @@ describe('Maka CLI args', () => {
assert.equal(help.kind, 'help');
if (help.kind === 'help') {
assert.match(help.text, /^Usage: npm run cli:dev --$/m);
assert.match(help.text, /^ {2}npm run cli:dev -- runtime-host \.\.\. /m);
assert.doesNotMatch(help.text, /^ {2}maka runtime-host /m);
assert.doesNotMatch(help.text, /maka-agent/);
}
// The launcher name has to survive every layer, not just the root.
const hostHelp = parseMakaCliArgs(['runtime-host', '--help'], '0.1.0', 'npm run cli:dev --');
assert.equal(hostHelp.kind, 'help');
if (hostHelp.kind === 'help') {
assert.match(hostHelp.text, /^Usage: npm run cli:dev -- runtime-host <command>/m);
}
const accessHelp = parseMakaCliArgs(
['runtime-host', 'access', '--help'],
'0.1.0',
'npm run cli:dev --',
);
assert.equal(accessHelp.kind, 'help');
if (accessHelp.kind === 'help') {
assert.match(
help.text,
/^ npm run cli:dev -- runtime-host access issue --principal <id> --preset /m,
);
assert.match(help.text, /^ npm run cli:dev -- runtime-host project list /m);
assert.match(
help.text,
/^ npm run cli:dev -- runtime-host profile set .*--ssh-destination /m,
accessHelp.text,
/^ {2}npm run cli:dev -- runtime-host access issue --principal <id> --preset /m,
);
assert.match(help.text, /^ npm run cli:dev -- runtime-host profile set .*--plaintext-url /m);
assert.doesNotMatch(help.text, /^ maka runtime-host /m);
assert.doesNotMatch(help.text, /maka-agent/);
}
await assert.rejects(
runMakaCli(['--version'], {
Expand Down Expand Up @@ -366,3 +375,74 @@ async function readClientInstanceId(path: string): Promise<string> {
}
return document.clientInstanceId;
}

describe('layered help coverage', () => {
const screens = (launcher = 'maka') => {
const texts: string[] = [];
const grab = (argv: string[]) => {
const command = parseMakaCliArgs(argv, '0.1.0', launcher);
if (command.kind === 'help') texts.push(command.text);
};
grab(['--help']);
grab(['update', '--help']);
grab(['session-export', '--help']);
grab(['session-import', '--help']);
grab(['runtime-host', '--help']);
for (const topic of [
'activate',
'serve',
'setup',
'service',
'access',
'project',
'plugin',
'profile',
'capability-provider',
]) {
grab(['runtime-host', topic, '--help']);
}
return texts.join('\n');
};

test('every command the parser accepts has a help screen', () => {
const all = screens();
for (const command of [
'runtime-host activate',
'runtime-host serve',
'runtime-host setup',
'runtime-host service',
'runtime-host access',
'runtime-host project',
'runtime-host plugin',
'runtime-host profile',
'runtime-host capability-provider',
'session-export',
'session-import',
'update',
]) {
assert.ok(all.includes(`maka ${command}`), `${command} is unreachable from any help screen`);
}
});

test('the credential environment variable stays documented', () => {
// Its only other home was the root screen, which the layering shrank.
assert.match(screens(), /MAKA_RUNTIME_HOST_ACCESS_CREDENTIAL/);
});

test('every summary in the root screen shares one column', () => {
const help = parseMakaCliArgs(['--help'], '0.1.0');
assert.equal(help.kind, 'help');
if (help.kind !== 'help') return;
const summaryColumns = help.text
.split('\n')
.filter((line) => /^ {2}maka\b/.test(line))
.map((line) => line.search(/(?<= {2})\S(?!.*\s{2}\S)/u))
.filter((column) => column > 0);
assert.ok(summaryColumns.length > 5, 'the root screen should list several commands');
assert.equal(
new Set(summaryColumns).size,
1,
`summaries start at ${[...new Set(summaryColumns)].join(', ')}`,
);
});
});
139 changes: 30 additions & 109 deletions packages/cli/src/cli-core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
parseRuntimeHostInstalledUpdateCommand,
type RuntimeHostCliCommand,
} from './runtime-host-cli.js';
import { sessionBundleHelpText } from './runtime-host-help.js';
import { resolveCliUiLocale } from './cli-ui-locale.js';

export type MakaCliCommand =
Expand Down Expand Up @@ -85,11 +86,14 @@ export function parseMakaCliArgs(
if (first?.startsWith('--')) return parseTuiArgs(argv);
if (first === 'run' || first === '-p') return { kind: 'run', args: argv.slice(1) };
if (first === 'activate') return { kind: 'activate', args: argv.slice(1) };
if (first === 'session-export') return { kind: 'session-export', args: argv.slice(1) };
if (first === 'session-import') return { kind: 'session-import', args: argv.slice(1) };
if (first === 'session-export' || first === 'session-import') {
return argv[1] === '--help' || argv[1] === '-h'
? { kind: 'help', text: sessionBundleHelpText(cliCommand, first) }
: { kind: first, args: argv.slice(1) };
}
if (first === 'eval') return { kind: 'eval', args: argv.slice(1) };
if (first === 'update') return parseRuntimeHostInstalledUpdateCommand(argv.slice(1));
if (first === 'runtime-host') return parseRuntimeHostCommand(argv.slice(1));
if (first === 'update') return parseRuntimeHostInstalledUpdateCommand(argv.slice(1), cliCommand);
if (first === 'runtime-host') return parseRuntimeHostCommand(argv.slice(1), cliCommand);
return {
kind: 'error',
message: `Unexpected argument: ${first ?? ''}`,
Expand Down Expand Up @@ -136,48 +140,27 @@ function helpText(cliCommand: string): string {
'Launches the Maka terminal UI in the current working directory.',
'',
'Commands:',
` ${cliCommand} Start the TUI`,
` ${cliCommand} --acp Serve ACP v1 over stdio (initialize, session/new, session/list)`,
` ${cliCommand} run ... Run one non-interactive model turn`,
` ${cliCommand} activate ... Run one Cloud Session activation and emit JSONL`,
` ${cliCommand} session-export --workspace-root <dir> --session <id> --out <file.maka-session>`,
` ${cliCommand} session-import --workspace-root <dir> --bundle <file.maka-session>`,
` ${cliCommand} -p ... Alias for ${cliCommand} run`,
` ${cliCommand} eval ... Run one declarative multi-arm experiment`,
` ${cliCommand} update --target <latest|next|version> Update this npm-global CLI and its local Runtime Host`,
` ${cliCommand} runtime-host serve [options] Run a Runtime Host service`,
` ${cliCommand} runtime-host activate --framed --root-id <id>`,
` ${cliCommand} runtime-host setup --principal <id> --preset <desktop-client|terminal-client> [options]`,
` ${cliCommand} runtime-host service install [options]`,
` ${cliCommand} runtime-host service configure (--project-root <label>=<path> ... | --no-project-roots) --expected-config-fingerprint <sha256:...> --expected-service-id <id> --expected-root-path <path> --expected-root-id <id> [--allow-interrupt-active-tasks]`,
` ${cliCommand} runtime-host service status|start|stop|restart|logs [--json]`,
` ${cliCommand} runtime-host service uninstall --expected-service-id <id> --expected-root-path <path> --expected-root-id <id> [--allow-interrupt-active-tasks]`,
` ${cliCommand} runtime-host service peer enable|disable|status|rotate|descriptor [options]`,
` ${cliCommand} runtime-host service mesh status|create|invite|join|remove|leave|close|reconcile [options]`,
` ${cliCommand} runtime-host service retire --expected-service-id <id> --expected-root-path <path> --expected-root-id <id> [--allow-interrupt-active-tasks]`,
` ${cliCommand} runtime-host service check-update --target <latest|next|version> [--json]`,
` ${cliCommand} runtime-host service update [--target <latest|next|version>] --expected-service-id <id> --expected-root-path <path> --expected-root-id <id> [--allow-interrupt-active-tasks]`,
` ${cliCommand} runtime-host service update-policy [--target <manual|latest|next|version>] [--json]`,
` ${cliCommand} runtime-host service reconcile-update [--json]`,
` ${cliCommand} runtime-host access issue --principal <id> --grant <operation>`,
` ${cliCommand} runtime-host access issue --principal <id> --preset <desktop-client|terminal-client>`,
` ${cliCommand} runtime-host access connection-code [--name <name>] [--root <path>]`,
` ${cliCommand} runtime-host access list`,
` ${cliCommand} runtime-host access issue --kind capability-provider --principal <id>`,
` ${cliCommand} runtime-host access revoke --credential <id>`,
` ${cliCommand} runtime-host project list [--root <path>]`,
` ${cliCommand} runtime-host project add <path> [--prefer] [--root <path>]`,
` ${cliCommand} runtime-host plugin status|list|inspect|failures [--root <path>]`,
` ${cliCommand} runtime-host plugin install|uninstall|reload <target> [--root <path>]`,
` ${cliCommand} runtime-host plugin export <extension-id> <bundle-path> [--root <path>]`,
` ${cliCommand} runtime-host plugin apply <operations.json> [--root <path>]`,
` ${cliCommand} runtime-host plugin reconcile [--root <path>]`,
` ${cliCommand} runtime-host profile list`,
` ${cliCommand} runtime-host profile set --id <id> --name <name> --tls-url <wss-url> --expected-root <root-id> [--credential-env <name>]`,
` ${cliCommand} runtime-host profile set --id <id> --name <name> --ssh-destination <user@host> --ssh-remote-port <port> --expected-root <root-id> [--ssh-port <port>] [--credential-env <name>]`,
` ${cliCommand} runtime-host profile set --id <id> --name <name> --plaintext-url <ws-url> --acknowledge-plaintext --expected-root <root-id> [--credential-env <name>]`,
` ${cliCommand} runtime-host profile remove --id <id>`,
` ${cliCommand} runtime-host capability-provider serve --url <ws-url> --mcp-config <path> --expected-root <root-id>`,
...(
[
['', 'Start the TUI'],
['--acp', 'Serve ACP v1 over stdio (initialize, session/new, session/list)'],
['run ...', 'Run one non-interactive model turn'],
['-p ...', `Alias for ${cliCommand} run`],
['activate ...', 'Run one Cloud Session activation and emit JSONL'],
['eval ...', 'Run one declarative multi-arm experiment'],
['session-export ...', 'Write a Session bundle to a file'],
['session-import ...', 'Read a Session bundle back into a workspace'],
['update ...', 'Update this npm-global CLI and its local Runtime Host'],
['runtime-host ...', 'Serve and manage a Runtime Host'],
] as const
).map(([name, summary], _index, entries) => {
// A custom launcher ("npm run cli:dev --") is far wider than `maka`, so the
// column is measured, never assumed.
const width = Math.max(
...entries.map(([other]) => `${cliCommand} ${other}`.trimEnd().length),
);
return ` ${`${cliCommand} ${name}`.trimEnd().padEnd(width + 2)}${summary}`;
}),
'',
'Options:',
' -h, --help Show help',
Expand All @@ -186,70 +169,8 @@ function helpText(cliCommand: string): string {
' --resume <id> --cwd <path> Reopen a session after its directory moved',
' --host <profile-id> Connect the TUI to a saved Runtime Host profile',
' --project <project-id> Select an existing Project on a remote Host',
' MAKA_RUNTIME_HOST_ACCESS_CREDENTIAL Access credential used by runtime-host profile set',
'',
'Runtime Host serve options:',
' --root <path> Select the canonical data root',
' --project-root <label>=<path> Publish an absolute project directory root (repeatable)',
' --no-project-roots Disable remote project browsing and registration',
' --websocket-port <port> Enable an authenticated WebSocket listener',
' --websocket-host <host> Bind host (default: 127.0.0.1)',
' --websocket-path <path> Upgrade path (default: /runtime-host)',
' --tls-certificate <path> TLS certificate for WSS',
' --tls-private-key <path> TLS private key for WSS',
' --allow-insecure-remote Allow plaintext WebSocket access beyond loopback',
' --allow-origin <origin> Allow one browser Origin (repeatable)',
' --peer-native-path <path> Load the experimental direct-peer native module',
' --peer-key <path> Persist the direct-peer transport identity',
' --peer-id <id> Require an existing direct-peer transport identity',
' --peer-listen <multiaddr> Listen on a direct-peer address (repeatable)',
' --peer-coordination-relay <multiaddr> Use a DCUtR coordination relay (repeatable)',
' --json Emit one machine-readable ready event',
'',
'Managed Runtime Host service install options (Linux or macOS):',
' --root <path> Select the canonical data root',
' --project-root <label>=<path> Publish an absolute directory root (repeatable)',
' --no-project-roots Disable remote project browsing and registration',
' --websocket-port <port> Persist a loopback port (chosen automatically by default)',
' --websocket-path <path> Persist the upgrade path (default: /runtime-host)',
' --json Emit a machine-readable result',
'',
'Managed Runtime Host setup options (Linux or macOS):',
' --principal <id> Stable Client pairing identity',
' --preset <name> Pair a desktop-client or terminal-client',
' --root <path> Select the canonical data root',
' --project-root <label>=<path> Publish an absolute directory root (repeatable)',
' --no-project-roots Disable remote project browsing and registration',
' --websocket-port <port> Persist a loopback port (chosen automatically by default)',
' --websocket-path <path> Persist the upgrade path (default: /runtime-host)',
' --json Emit framed machine-readable progress and result records',
'',
'Managed Runtime Host direct-peer options:',
' --listen <multiaddr> Persist a listener address (repeatable)',
' --coordination-relay <addr> Prefer a Circuit Relay v2 address (repeatable)',
' --clear-coordination-relays Remove every manually configured relay',
' --automatic-relay-discovery Enable best-effort public relay discovery',
' --no-automatic-relay-discovery Disable public discovery and retain manual relays',
' --default-public-stun Use the packaged best-effort public STUN policy',
' --no-public-stun Disable public STUN and keep host candidates only',
' --webrtc-stun <stun-url> Use a custom STUN endpoint (repeatable)',
'',
'Runtime Host access issue options:',
' --root <path> Select the canonical data root',
' --kind <kind> remote-owner or capability-provider',
' --principal <id> Name the authenticated Client principal',
' --grant <operation> Grant one exact operation (repeatable)',
' --preset <name> Grant the desktop-client or terminal-client operation set',
' --publish-client-capabilities Allow Client Capability publication',
' --allow-host-paths Allow operations that submit Host paths',
' --capability-owner-credential <id> Bind a provider to one Client-bound owner credential',
'',
'Runtime Host capability provider options:',
' --url <ws-url> Connect to an authenticated Runtime Host WebSocket',
' --mcp-config <path> Publish tools from an MCP configuration file',
' --expected-root <root-id> Pin the canonical Runtime Host root identity',
' --credential-env <name> Read the access credential from this environment variable',
' --client-identity <path> Persist the provider Client instance identity here',
`Run \`${cliCommand} <command> --help\` for a command's own options.`,
].join('\n');
}

Expand Down
Loading
Loading