Secbot is an AI-powered TypeScript security automation workspace with a NestJS backend and an Ink-based terminal UI.
Security notice: this package is for authorized security testing, research, and education only. Do not run scans or exploitation tasks against targets without explicit permission.
- End-to-end TypeScript architecture (
NestJS + Ink + SQLite). secbotbinary that starts terminal UI with local spawned backend by default.secbot-serverbinary for backend-only API scenarios.- Multi-agent orchestration with planning, tool execution, and summarization.
- Built-in security tool modules for web, network, OSINT, defense, and reporting workflows.
- Node.js
>= 24 - npm
>= 10(recommended) - Optional: Ollama for local model serving
npm install -g @opensec/secbotnpx @opensec/secbotCreate a .env file in your working directory:
# Cloud model backend (recommended)
LLM_PROVIDER=deepseek
DEEPSEEK_API_KEY=sk-your-api-key
DEEPSEEK_MODEL=deepseek-reasoner
# Optional local backend (Ollama)
# LLM_PROVIDER=ollama
# OLLAMA_BASE_URL=http://localhost:11434
# OLLAMA_MODEL=gemma3:1bsecbotsecbot-server# Recommended explicit service mode
SECBOT_TUI_BACKEND=service SECBOT_API_URL=http://127.0.0.1:8000 secbot
# Backward-compatible alias
SECBOT_TUI_BACKEND=remote SECBOT_API_URL=http://127.0.0.1:8000 secbot| Binary | Description |
|---|---|
secbot |
Start terminal UI (default: spawn local backend; optional service mode) |
secbot-server |
Start NestJS backend only |
git clone https://github.com/iammm0/secbot.git
cd secbot
npm ci
# Backend dev (watch mode)
npm run dev
# TUI (in another terminal, default: spawn local backend)
npm run start:tui
# TUI service mode (connect existing backend only)
SECBOT_TUI_BACKEND=service SECBOT_API_URL=http://127.0.0.1:8000 npm run start:tui| Script | Description |
|---|---|
npm run build |
Build backend and package artifacts |
npm run typecheck |
Type-check server code |
npm run lint |
Run ESLint |
npm run format:check |
Check Prettier formatting |
npm test |
Run tests |
npm run release:pack |
Build and create npm package tarball |
- Quickstart
- API Reference
- LLM Providers
- Ollama Setup
- UI Interaction Design
- Tool Extension
- Release Guide
- Security Warning
- npm: https://www.npmjs.com/package/@opensec/secbot
- GitHub Packages: https://github.com/iammm0/secbot/packages
- Repository: https://github.com/iammm0/secbot
- Issues: https://github.com/iammm0/secbot/issues
This project is licensed under MIT. See LICENSE for details.