mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-10-02 22:36:49 +02:00
ezl-keygraph
dc2a4fe4e8
* docs: rebuild the npm package README on the main README's identity * docs: point the README banner fallback at an asset that exists * docs: declare the npm package author, homepage, and issue tracker * docs(cli): retire "Framework" and settle on the canonical product line * docs: describe the banner image in alt text instead of repeating the lockup * feat(cli): print a plain-text banner when stdout is not a terminal * feat(report): attribute the markdown report from a shared brand constant * feat(cli): frame the plain-text banner with rules and split the version line * docs: drop the URL from the npm author field
95 lines
4.0 KiB
TypeScript
95 lines
4.0 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'));
|
|
}
|
|
|
|
/** Matches the divider width the CI wrappers and the scan renderer already use. */
|
|
const RULE_WIDTH = 60;
|
|
|
|
/**
|
|
* Plain-text banner for non-terminal output (CI logs, pipes, redirects).
|
|
* Drops the wordmark but keeps the authorized-use notice, which a reader of
|
|
* someone else's pipeline log still needs to see.
|
|
*/
|
|
export function displayPlainBanner(version?: string): void {
|
|
const rule = '─'.repeat(RULE_WIDTH);
|
|
console.log(rule);
|
|
console.log(version ? ` Shannon v${version}` : ' Shannon');
|
|
console.log(' AI Pentester for Web Apps and APIs, by Keygraph');
|
|
console.log(' Authorized security testing only.');
|
|
console.log(rule);
|
|
}
|