oncall-cli
v2.0.3
Published
**OnCall - Your AI-powered CLI Debugger**
Readme
OnCall CLI
OnCall - Your AI-powered CLI Debugger
OnCall CLI is an intelligent command-line tool that helps you debug your applications in real-time using AI assistance. Run your commands, view logs, and get AI-powered insights all in one interactive terminal interface.
Features
- 🤖 AI-Powered Debugging: Get intelligent assistance while debugging your applications
- 📊 Real-time Log Analysis: View and analyze command output logs in real-time
- 🔍 Code Search: Search through your codebase with AI assistance
- 💬 Interactive Chat: Chat with AI about your debugging issues
- 🚀 Easy Setup: Get started in minutes with simple initialization
Installation
npm install -g oncall-cliQuick Start
1. Initialize OnCall
oncall init -m "Your project description"This will:
- Create a configuration directory at
~/.oncall/ - Generate an
oncall.yamlfile in your project directory - Set up your project for OnCall
2. Login
Get your API key from OnCall Web Studio and login:
oncall login <your-auth-key>3. Start Debugging
Run any command with OnCall:
oncall npm run dev
oncall python app.py
oncall node server.jsOnCall will launch an interactive terminal interface where you can:
- View command logs in real-time
- Chat with AI about debugging issues
- Search your codebase
- Get intelligent suggestions
Commands
oncall init [-id <project-id>] -m <description>
Initialize OnCall configuration and register your project directory.
Options:
-id <project-id>: Specify a project ID (optional)-m <description>: Project description (required)
Example:
oncall init -id my-project -m "Node.js API backend"oncall login <your-auth-key>
Login to OnCall using your authentication key from OnCall Web Studio.
Example:
oncall login abc123xyz789oncall cluster
Start the lightweight local WebSocket server for cluster functionality.
Example:
oncall clusteroncall config [-id <project-id>] -m <description>
Update project configuration for the current directory.
Example:
oncall config -id my-project -m "Updated description"oncall <command>...
Run any command with OnCall's interactive debugging interface.
Examples:
oncall npm run dev
oncall python manage.py runserver
oncall docker-compose upConfiguration
OnCall stores its configuration in ~/.oncall/config. You can manually edit this file if needed:
# OnCall Configuration File
#
# Place your OnCall API key here.
# You can get a key from OnCall Web Studio.
#
API_KEY=your-api-key-here
# Project mappings (stored as JSON)
projects=[]Project Metadata
OnCall creates an oncall.yaml file in your project directory with metadata:
id: "project-id"
description: "Your project description"
name: "Project Name"
window_id: 1234567890
logs_available: true
code_available: trueEnvironment Variables
ONCALL_CLUSTER_URL: WebSocket URL for the cluster server (default:ws://127.0.0.1:4466)ONCALL_WS_PORT: Port for the WebSocket server (default:6111)ONCALL_WS_HOST: Host for the WebSocket server (default:127.0.0.1)API_BASE_URL: Base URL for the OnCall API (default:https://api.oncall.build/v2/api)
Keyboard Shortcuts
When using the interactive interface:
Tab: Switch focus between panes↑/↓: Scroll (Keyboard Only)Enter: Send messageCtrl+D: Toggle chat/logs viewCtrl+C: ExitCtrl+R: Reload AI chat
Requirements
- Node.js 18+
- npm or yarn
Support
For issues, questions, or contributions, please visit:
- Website: https://oncall.build
- Web Studio: https://app.oncall.build
License
MIT
