mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-08-25 12:43:09 +02:00
* refactor(cli): list workspaces natively instead of via the worker image * feat(cli): preflight that Docker is installed and running * feat(cli): stop scans by workspace or --all, terminating their Temporal workflows * fix(worker): abort the running agent on cancellation so Temporal cancel takes effect * refactor(cli): split destructive teardown out of stop into a reset command * refactor(cli): centralise flag parsing and confirmation across commands * fix(cli): pass provider credentials to docker by name to keep secrets out of argv * feat(cli): add per-command help via <command> --help/-h and help <command> * feat(cli): replace raw docker output with clack spinners for infra and scan teardown * fix(cli): verify scan stop by re-querying container and workflow state instead of assuming success * fix(cli): resolve running state before prompting on stop and report no-op stops honestly * refactor(cli): show splash first and drive start with one spinner resolving to a clean line * fix(cli): validate --url up front so a bad value fails cleanly instead of a late crash * refactor(cli): centralize error reporting with fail() for expected errors and a crash handler that logs the stack and links the issue tracker * feat(cli): add --json/--plain machine-readable output to workspaces and status * refactor(cli): remove the workspaces command * refactor(cli): remove the status command * feat(cli): add 'progress <workspace>' — live scan progress from Temporal * fix(cli): mark metric-less agents as skipped in progress, not done * feat(cli): animate running agents in progress with a clack-style spinner * feat(cli): rename progress->status, reveal agents as they run, show live per-agent elapsed * fix(cli): mark passed-over phases as skipped live, not pending * style(cli): rename status footer 'Wall-clock' to 'Time Taken', drop the parenthetical * style(cli): drop '(sum of agents)' from status total cost line * style(cli): green filled circle for completed, Shannon gold for running * style(cli): use Shannon gold in place of green in status * feat(cli): suggest closest command or flag on typo * refactor(cli): single-source start help and drop ./repos bare-name shortcut * feat(cli): name providers and fix in multi-provider credential error * feat(cli): support --flag=value syntax and expand leading ~ in paths * refactor(cli): centralize ANSI color codes in colors.ts * feat(cli): add scans command listing completed scans with cost and duration * fix(cli): keep stdout clean off-TTY for logs and start * feat(cli): add repo link to top-level help * feat(worker): record auth-validation metrics and register resume attempts early * refactor(cli): share resume-aware workflow-id resolution and surface root-cause failures * feat(cli): add status --json, auth phase, dashboard link, and stable live redraw * refactor(cli): drop cost from status and scans output * feat(worker): surface both PDF and markdown report at run root * refactor(cli): normalize error/warning prefixing through fail and warn * feat(cli): add version --json for machine-readable output * refactor(cli): rename start --debug to --keep-container * refactor(cli): point start's progress hint at status instead of the Temporal dashboard * refactor(cli): centralize the mode-aware command prefix * refactor(cli): trim start and logs output to durable facts off-TTY * feat(cli): require typed confirmation for reset instead of --yes reset permanently wipes all Temporal data and volumes — a severe, irreversible action. Replace its default y/N confirm (bypassable with --yes) with a typed-word confirmation that has no bypass, so the wipe can only be triggered by a deliberate interactive answer. * feat(cli): surface logs and status hints after start on a TTY * feat(cli): exit 2 on usage errors, distinct from operational failures * feat(cli): add start --follow to stream logs and exit on scan outcome * refactor(cli): redesign splash with sunset-gradient wordmark and truecolor * refactor(cli): remove the uninstall command * docs: sync CLI docs with removed uninstall/workspaces, new scans and --follow * docs: fix reset confirmation — typed confirm, not --yes/-y * style(cli): restructure status footer with divider, aligned Logs/Temporal rows * feat(cli): show splash in the status command * fix(worker): validate auth-state shape, not entry count * docs: correct reset confirmation and add markdown report to run-root docs
78 lines
3.4 KiB
TypeScript
78 lines
3.4 KiB
TypeScript
/**
|
|
* Splash screen display — pure terminal output, no npm dependencies.
|
|
* Color escapes are gated on terminal support; the Unicode art is always kept.
|
|
*/
|
|
|
|
import { supportsColor } from './tty.js';
|
|
|
|
/** SHANNON wordmark. Block glyphs take the row fill; box-drawing strokes take the deeper edge shade. */
|
|
const SHANNON = [
|
|
'███████╗██╗ ██╗ █████╗ ███╗ ██╗███╗ ██╗ ██████╗ ███╗ ██╗',
|
|
'██╔════╝██║ ██║██╔══██╗████╗ ██║████╗ ██║██╔═══██╗████╗ ██║',
|
|
'███████╗███████║███████║██╔██╗ ██║██╔██╗ ██║██║ ██║██╔██╗ ██║',
|
|
'╚════██║██╔══██║██╔══██║██║╚██╗██║██║╚██╗██║██║ ██║██║╚██╗██║',
|
|
'███████║██║ ██║██║ ██║██║ ╚████║██║ ╚████║╚██████╔╝██║ ╚████║',
|
|
'╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═══╝╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═══╝',
|
|
];
|
|
|
|
/**
|
|
* Sunset ramp, yellow at the top row down to burnt orange at the base.
|
|
* Wordmark row i is filled with stop i and edged with stop i + 1, so the
|
|
* box-drawing strokes read as a shadow one shade deeper than their row.
|
|
* `xterm` is the 256-color approximation for terminals without 24-bit color.
|
|
*/
|
|
const SUNSET: ReadonlyArray<{ rgb: readonly [number, number, number]; xterm: number }> = [
|
|
{ rgb: [247, 203, 45], xterm: 220 },
|
|
{ rgb: [246, 182, 38], xterm: 220 },
|
|
{ rgb: [245, 160, 32], xterm: 214 },
|
|
{ rgb: [242, 141, 28], xterm: 214 },
|
|
{ rgb: [238, 121, 24], xterm: 208 },
|
|
{ rgb: [231, 100, 21], xterm: 208 },
|
|
{ rgb: [222, 82, 19], xterm: 202 },
|
|
];
|
|
|
|
export function displaySplash(version?: string): void {
|
|
const color = supportsColor();
|
|
const truecolor = color && /truecolor|24bit/i.test(process.env.COLORTERM ?? '');
|
|
const RESET = color ? '\x1b[0m' : '';
|
|
const WHITE = color ? '\x1b[1;97m' : '';
|
|
const GRAY = color ? '\x1b[0;37m' : '';
|
|
const DIM = color ? '\x1b[90m' : '';
|
|
|
|
const ramp = SUNSET.map(({ rgb: [r, g, b], xterm }) => {
|
|
if (!color) return '';
|
|
return truecolor ? `\x1b[38;2;${r};${g};${b}m` : `\x1b[38;5;${xterm}m`;
|
|
});
|
|
|
|
/** Color one wordmark row, emitting an escape only where the run changes. Spaces stay unpainted. */
|
|
const paint = (row: string, fill: string, edge: string): string => {
|
|
if (!color) return row;
|
|
let out = '';
|
|
let open = '';
|
|
for (const ch of row) {
|
|
const want = ch === ' ' ? '' : ch === '█' ? fill : edge;
|
|
if (want !== open) {
|
|
if (open) out += RESET;
|
|
out += want;
|
|
open = want;
|
|
}
|
|
out += ch;
|
|
}
|
|
return open ? out + RESET : out;
|
|
};
|
|
|
|
const lines = [
|
|
'',
|
|
` ${WHITE}Keygraph${RESET}${version ? ` ${DIM}v${version}${RESET}` : ''}`,
|
|
'',
|
|
...SHANNON.map((row, i) => ` ${paint(row, ramp[i] ?? '', ramp[i + 1] ?? '')}`),
|
|
'',
|
|
` ${WHITE}AI Pentester for Web Apps and APIs${RESET}`,
|
|
'',
|
|
` ${GRAY}-Authorized Security Testing Only-${RESET}`,
|
|
'',
|
|
];
|
|
|
|
console.log(lines.join('\n'));
|
|
}
|