apix-dev-cli
v1.3.0
Published
AI-powered CLI tool for API testing, generation, and execution from terminal
Maintainers
Readme
🚀 Apix - AI-Powered CLI for API Testing
Apix is a lightweight CLI tool that lets you run, save, and generate API requests directly from your terminal - with built in AI support.
⚡ Skip Postman. Stay in your terminal. Move faster.
Apix
npm: https://www.npmjs.com/package/apix-dev-cli
AI-powered CLI tool for API testing, request generation, and execution directly from the terminal.
Apix v1.3.0 (Chaining and Workflows)
API chains
APIX lets you define multiple API requests as a chain and execute them sequentially
Each chain is stored as a .json file, where every step contains its own request configuration
Create a chain:
Create a JSON file such as text login-flow.json
{
"steps": [
{
"name": "Login",
"method": "POST",
"url": "https://api.example.com/login",
"headers": { "Content-Type": "application/json" },
"body": { "email": "[email protected]", "password": "secret" },
"extract": { "token": "token", "userId": "user.id" }
},
{
"name": "Profile",
"method": "GET",
"url": "https://api.example.com/users/{{userId}}",
"headers": { "Authorization": "Bearer {{token}}" }
}
]
}apix chain save auth-flow
apix chain run auth-flow
apix chain listUse --file path/to/chain.json when the definition has a different name. Values extracted with extract can be used in later URLs, headers, and bodies as {{variable}}. A missing value, failed extraction or failed request stops the chain and reports the step that failed.
🚀 Apix v1.2.0
Developer Workflow Update
🌍 Environment Management
Manage multiple environments for different APIs.
apix env create-env local
apix env create-env production
apix env use-env production
apix env list-env
apix env current-env
apix env delete-env production
🔑 Environment Variables
Store variables separately for each environment.
apix var set TOKEN abc123
apix var get TOKEN
apix var list
apix var delete TOKEN
## ✨ Features
* ⚡ Run API requests (GET, POST, PUT, DELETE)
* 💾 Save & reuse API configurations
* 🤖 Generate APIs using natural language (AI-powered)
* 🔥 Instant execution (`--run`)
* 📦 Persistent request storage
* 🧠 Supports JSON and key=value body formats
* 🧩 Simple, developer-friendly CLI
---
## 📦 Installation
```bash id="b4m3k2"
npm install -g apix-dev-cli🚀 Quick Start
🔹 Run a simple GET request
apix run GET https://dummyjson.com/users🔹 Run a POST request (JSON)
apix run POST https://dummyjson.com/users/add -H "Content-Type:application/json" -d '{ "firstName": "Aayush", "lastName": "Singh" }'Run apix help for more INFO
🔹 Run using key=value format
apix run POST https://dummyjson.com/users/add -d name="Aayush" role="Developer"💾 Save & Reuse Requests
apix save GET https://dummyjson.com/users
apix list
apix run 1🤖 AI Features (Core Highlight)
🔹 Generate API from natural language
Would require a groq API key
apix generate "create login api"🔹 Generate and run instantly
apix generate "create login api" --run🔹 Generate, save and run
apix generate "create user api" --save --runScreenshots:
1)APIX Generate in action
- Apix Run command
- More examples
📘 Examples
🌤 Weather API (query params)
apix run GET "https://api.open-meteo.com/v1/forecast?latitude=28.6&longitude=77.2¤t_weather=true"🛒 Fake Store API
apix run GET https://fakestoreapi.com/products🧪 Save and execute later
apix save POST https://dummyjson.com/users/add -d name="Aayush"
apix run 2⚙️ Commands
| Command | Description |
| --------------------- | ------------------- |
| run <method> <url> | Run API request |
| run <id> | Run saved request |
| save <method> <url> | Save request |
| list | List saved requests |
| edit <id> | Edit request |
| delete <id> | Delete request |
| generate "<prompt>" | AI generate request |
🔑 AI Setup (Required for AI Features)
Apix uses Groq API for AI-powered features.
1️⃣ Get API Key
👉 https://console.groq.com/keys
2️⃣ Set Environment Variable
🪟 Windows (PowerShell)
setx GROQ_API_KEY "your_api_key_here"🍎 Mac/Linux
export GROQ_API_KEY="your_api_key_here"3️⃣ Restart your terminal
⚠️ Notes
- For PowerShell, wrap JSON in single quotes
-d '{ "key": "value" }'AI-generated URLs may sometimes be placeholders — update if needed
Without API key:
- ✅ Run / Save features work
- ❌ AI features will not work
🛣 Roadmap/Future Development Plan
- 🔗 API chaining
- 🌍 Environment variables (BASE_URL)
- 📜 Version history (Git-style)
- 🤖 Improved AI suggestions
📄 License
MIT License
👨💻 Author
Built by Aayush Singh
⭐ Support
If you found this useful, consider giving it a star ⭐ on GitHub!
