README
¶
Octrafic
AI-powered CLI tool for API testing and exploration. Chat naturally with your APIs - no scripts, no configuration files, just conversation.
Features
- Natural language testing - Describe what you want to test, AI generates the right requests
- Intelligent exploration - Ask questions about endpoints, parameters, and responses
- Automated test generation - Comprehensive test suites based on your API specs
- Multiple AI providers - Claude, OpenRouter, OpenAI, Ollama, llama.cpp
- Flexible authentication - Bearer tokens, API keys, Basic auth with secure credential handling
- Format support - OpenAPI/Swagger (JSON/YAML), Postman Collections, GraphQL, Markdown
Quick Start
Install
Linux & macOS:
curl -fsSL https://octrafic.com/install.sh | bash
Windows (PowerShell):
iex (iwr -useb https://octrafic.com/install.ps1)
macOS (Homebrew):
brew install octrafic/tap/octrafic
Arch Linux:
yay -S octrafic-bin
Other options: See INSTALL.md for package managers (DEB, RPM) and manual installation
Setup
On first launch, configure your AI provider:
Supported providers:
- Claude - console.anthropic.com
- OpenRouter - openrouter.ai/keys
- OpenAI - platform.openai.com
- Ollama (local) - ollama.com
- llama.cpp (local) - github.com/ggml-org/llama.cpp
Configuration is saved in ~/.octrafic/config.json
Usage
# Start interactive mode - browse projects or create new
octrafic
# Quick start with API spec
octrafic -u https://api.example.com -s openapi.json
# Create named project (saves automatically)
octrafic -u https://api.example.com -s spec.json -n "My API"
# Resume saved project
octrafic -n "My API"
Authentication
Your credentials never leave your machine - they're sent only to your API, not to AI providers.
# Bearer token
octrafic -u https://api.example.com -s spec.json --auth bearer --token "TOKEN"
# API key
octrafic -u https://api.example.com -s spec.json --auth apikey --key "X-API-Key" --value "KEY"
# Basic auth
octrafic -u https://api.example.com -s spec.json --auth basic --user "user" --pass "pass"
Auth is saved automatically with named projects (-n). Change during session with /auth command.
Example Session
octrafic -u https://jsonplaceholder.typicode.com -s api-spec.json
> what endpoints are available?
AI: This API has 5 main endpoints: /posts, /users, /comments...
> test the users endpoint
AI: I'll test GET /users [executes test and shows results]
> create a new post with title "Hello World"
AI: I'll send a POST request to /posts... [shows result]
Commands & Navigation
Chat commands: /help /auth /info /think /clear /exit
Keyboard: ↑/↓ command history · Page Up/Down scroll · Esc Esc clear input · Ctrl+C exit
Project Structure
octrafic/
├── cmd/octrafic/ # Main entry point
├── internal/
│ ├── agents/ # AI agent logic and system prompts
│ ├── cli/ # Terminal UI (Bubble Tea)
│ ├── core/ # Parser, test generator, validator
│ ├── infra/ # Storage, logger
│ └── llm/ # LLM client wrappers (Claude, OpenRouter, OpenAI, Ollama, llama.cpp)
├── docs/ # Documentation (VitePress)
└── README.md
Contributing
Contributions are welcome! See CONTRIBUTING.md for guidelines.
License
MIT - see LICENSE
Directories