🧠 NeuroPS CLI

AI-powered incident management and log analysis tool

📦 Installation

🟢 Via npm (Recommended)

Prerequisites

1. Node.js 14+ and npm must be installed:

   node --version
   npm --version

2. Python 3.8+ must be installed:

   python3 --version  # or python --version

   If Python is not installed: Python Download Page

Installation Steps

1. Install NeuroPS CLI globally:

   npm install -g neurops-cli

   This command will:

   • Download the neurops-cli package from npm
   • Automatically check and install Python dependencies
   • Add the neurops command to your system PATH

2. Verify the installation:

   neurops --version
   # or simply
   neurops

💡 Note:

• This package requires Python 3.8+. The npm package contains a Node.js wrapper that calls the Python CLI.
• Python dependencies (rich, requests, etc.) are automatically installed during setup.
• If Python is not found, the installation will warn you and you'll need to install Python manually.

🚀 Usage

After installation, run the CLI from any terminal:

neurops

The CLI provides an interactive menu for:

• 📊 Log Analysis - Analyze and search through logs
• 🚨 Incident Management - Track and manage incidents
• ⚙️ Workflow Automation - Create and run automated workflows
• 📺 Terminal Output Monitoring - Monitor terminal output in real-time
• 🤖 AI-Powered Problem Solving - Get AI assistance for troubleshooting
• 🛡️ Security & Protection - Security analysis and threat detection

⚙️ Configuration

The CLI stores configuration in ~/.neurops/config.json. You can configure:

API URL

Set the API URL via environment variable:

export NEUROPS_API_URL="https://api.neurops.dev"

Or configure it through the CLI menu (Option 9: Configure API URL).

The default API URL is https://api.neurops.dev.

Hugging Face API Token

To use AI features, you need to set your Hugging Face API token:

1. Get your token from: https://huggingface.co/settings/tokens
2. In the CLI menu, select Option 6: "AI Agent - Set Token"
3. Enter your token (it will be stored locally in ~/.neurops/config.json)

Your token is stored locally and sent with each API request. Each user uses their own token.

📋 Requirements

• Python 3.8+
• Node.js 14+ (for npm installation)
• rich library for terminal UI
• requests library for API calls
• PyYAML for workflow file parsing

📝 Features

Log Analysis

• Analyze logs for errors, warnings, and patterns
• Search through log entries
• Get AI-powered insights from logs

Incident Management

• Report and track incidents
• Update incident status
• Generate automated workflows for incidents
• View incident statistics

Workflow Automation

• Create workflows from natural language descriptions (AI-powered)
• Run automated workflows
• Monitor workflow execution
• View workflow history

AI Agent

• Problem analysis with AI assistance
• Automatic solution suggestions
• Auto-apply solutions (optional)
• Uses DeepSeek R1 model via Hugging Face

Security & Protection

• Security threat analysis
• Security event reporting
• Automated security workflows
• Security recommendations

🔗 API Connection

The CLI connects to the NeuroPS API server. The connection status is displayed in the main menu:

• ✓ Connected - API is reachable and responding
• ✗ Not Connected - API connection failed

If the API is not connected, check:

1. Your internet connection
2. API server status
3. API URL configuration (Option 9 in menu)

📄 License

MIT