# Octrafic

> Octrafic is an open source AI-powered CLI tool for automated API testing. Test APIs with natural language commands, generate PDF reports, and integrate seamlessly into your development workflow. Free forever.

## What is Octrafic?

Octrafic is a command-line interface (CLI) tool that uses AI to help developers test their APIs through natural language. Instead of writing complex test scripts, you simply describe what you want to test in plain English, and Octrafic's AI agent figures out the requests to make, runs them, and validates the responses.

## Key Features

- **Natural Language Testing**: Describe what you want tested (e.g., "check if /users returns paginated results") and the AI agent handles the rest
- **OpenAPI/Swagger Support**: Import your OpenAPI specification and Octrafic automatically understands your endpoints, parameters, and schemas
- **PDF Report Generation**: Export professional test reports in one command
- **Cross-Platform**: Single binary written in Go. Works on Linux, macOS, and Windows with no runtime dependencies
- **LLM Provider Support**: Compatible with OpenAI, Anthropic, and any OpenAI-compatible API (Ollama, LM Studio, etc.)
- **No Code Required**: Test APIs without writing a single line of test code

## Use Cases

- **API Development**: Test your API endpoints during development to catch issues early
- **CI/CD Integration**: Automate API testing in your continuous integration pipeline
- **QA Testing**: Non-technical team members can test APIs using natural language
- **API Documentation**: Validate that your API behaves as documented
- **Regression Testing**: Ensure API changes don't break existing functionality

## Installation

### Linux
```
curl -fsSL https://octrafic.com/install.sh | bash
```

### macOS
```
brew install octrafic/tap/octrafic
```

### Windows
```
iex (iwr -useb https://octrafic.com/install.ps1)
```

### Go
```
go install github.com/octrafic/octrafic@latest
```

## Quick Start

1. Set your LLM API key (OpenAI or Anthropic):
   ```
   export OPENAI_API_KEY=your-key
   # or
   export ANTHROPIC_API_KEY=your-key
   ```

2. Test an API:
   ```
   octrafic chat --url https://api.example.com
   ```

3. Describe what you want to test:
   ```
   > Check if the /users endpoint returns a list of users with proper pagination
   ```

## Documentation

Full documentation is available at: https://docs.octrafic.com

Topics covered:
- Installation and setup
- Configuration options
- OpenAPI/Swagger integration
- Advanced testing scenarios
- CI/CD integration
- Report generation
- Troubleshooting

## GitHub Repository

Source code: https://github.com/octrafic/octrafic-cli

The project is open source under the MIT license. Contributions, bug reports, and feature requests are welcome.

## Support

- GitHub Issues: https://github.com/octrafic/octrafic-cli/issues
- Documentation: https://docs.octrafic.com

## Technical Details

- **Written in**: Go
- **License**: MIT
- **Current Version**: 0.3.0
- **Platforms**: Linux, macOS, Windows
- **LLM Providers**: OpenAI, Anthropic, OpenAI-compatible APIs
- **API Support**: Any HTTP API (REST, GraphQL, etc.)

## Creator

Created by Mikołaj Badyl (https://github.com/mikolajbadyl)

## FAQ

**Is Octrafic really free?**
Yes. Octrafic is open source and free to use with no limits. You bring your own LLM API key.

**Which LLM providers are supported?**
OpenAI, Anthropic, and any OpenAI-compatible API (Ollama, LM Studio, etc.). Configure via environment variable or project settings.

**Does it work with any API?**
Any HTTP API. You can point it at an OpenAPI spec or just give it a base URL and describe what to test.

**How does natural language testing work?**
Just describe what you want to test — for example "check if /users returns paginated results". The AI agent figures out what requests to make, runs them, and validates the responses.

**What languages/platforms?**
It's a single binary written in Go. Works on Linux, macOS, and Windows. No runtime dependencies.