Project overview — Shell Sentinel

Mission

Deliver a terminal-native AI copilot that keeps persistent SSH/SFTP sessions, speaks natural language and brings human-friendly operations to critical infrastructure.

Technical stack

Key responsibilities

Workflow

  1. Create virtualenv with python3.12 -m venv .venv and activate it.
  2. Install dependencies via make install.
  3. Before PRs, run make format, make lint, make test (unit tests plus the offline end-to-end layer in tests/e2e, which drives the real TUI against an in-process SSH server).
  4. When touching the TUI, the agent runtime or a provider, optionally run make test-e2e-live (RUN_E2E=1 plus OPENAI_API_KEY, MISTRAL_API_KEY or GEMINI_API_KEY; the MCP scenarios also need FIRECRAWL_API_KEY and npx); it spends tokens and never runs in CI.
  5. Validate the TUI with make run and the website with make website-serve.

For complete policies refer to the contributor handbook and internal governance documents. Treat the static site as part of the documentation contract.