Files
penguin-harness/packages/cli/README.md
T
Yaowei Zheng 45bfae6e94 Initialize repository with harness code and assets
Initial import of all source code, config, and README assets: the
packages workspace (cli, core, server, web, docs, landing, skills),
build scripts, tooling config, and CI workflows.

Includes the data-layout revision made on this branch: the local data
root defaults to ~/.penguin/data (PENGUIN_HOME still overrides; the
installer keeps its binaries in ~/.penguin), and every Agent lives
under <project>/agents/<agent>/ — path helpers, the three
agent-enumeration scans, the system prompt, built-in Skills, tests
and docs all follow the new layout.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018ihk8iQuo3kv2aPjAYEPuR
2026-07-19 14:06:53 +08:00

1.8 KiB

@prismshadow/penguin-cli

The PenguinHarness command line. Installs the penguin command: an interactive REPL, a one-shot task runner, model / vault configuration, and the launcher for the Web service.

npm install -g @prismshadow/penguin-cli   # requires Node >= 24
penguin web        # start the Web service and open http://127.0.0.1:7364
penguin server     # same service, headless

penguin config model add --model-id deepseek-v4-pro --api-key sk-... --set-default

penguin run -m "Create hello.txt containing Hello, Penguin"    # one Task, then exit
penguin chat                                                   # REPL: /compact, /exit, Ctrl-C interrupts
penguin chat --resume                                          # resume the latest session

Tool calls go through an approval gate — --approve allow-all (default) | deny-all | read-only | always-ask. Data lives under ~/.penguin/data (PENGUIN_HOME or --root override); model credentials come from the Project config or provider env vars (e.g. DEEPSEEK_API_KEY).

Prefer a one-line install with a bundled Node runtime? See the installation guide.

Documentation

Development

pnpm penguin <args>                              # run from source (repo root, via tsx)
pnpm --filter @prismshadow/penguin-cli build     # tsup → dist/index.js (the penguin bin)
pnpm --filter @prismshadow/penguin-cli typecheck
pnpm --filter @prismshadow/penguin-cli test

Part of PenguinHarness · Apache-2.0