Commands Reference
Complete reference for all FixPanic CLI commands
This page provides a complete reference for all FixPanic CLI commands.
Agent Commands
All agent management commands are grouped under fixpanic agent.
fixpanic agent install
Installs and configures a new agent on the current server.
fixpanic agent install --agent-id=<id> --api-key=<key>Required Flags:
| Flag | Description |
|---|---|
--agent-id | The unique identifier for the agent (from dashboard) |
--api-key | The authentication key (from dashboard) |
What it does:
- Registers the agent with the FixPanic platform
- Downloads the connectivity layer binary
- Creates configuration files
- Sets up and starts the systemd service (on Linux with root)
Example:
fixpanic agent install \
--agent-id="clust_abc123def456" \
--api-key="sk_live_xxxxxxxxxxxxx"fixpanic agent status
Displays the current status of the agent service.
fixpanic agent statusOutput includes:
- Running state (Active/Stopped)
- Connection status (Connected/Disconnected)
- Version information
- Uptime
Example output:
Agent Status: Active
Connection: Connected
Version: 1.0.0
Uptime: 2h 34m 12s
PID: 12345fixpanic agent start
Manually starts the agent process.
fixpanic agent startUse this if the agent was stopped manually or failed to start automatically.
fixpanic agent stop
Manually stops the agent process.
fixpanic agent stopWarning: Stopping the agent will disconnect it from the FixPanic platform. You won't be able to send commands to this server until the agent is restarted.
fixpanic agent restart
Restarts the agent process.
fixpanic agent restartEquivalent to running stop followed by start. Useful after configuration changes.
fixpanic agent logs
Displays the agent's log output.
fixpanic agent logs [flags]Flags:
| Flag | Short | Description | Default |
|---|---|---|---|
--follow | -f | Stream logs in real-time | false |
--lines | -n | Number of lines to show | 100 |
Examples:
# Show last 100 lines
fixpanic agent logs
# Show last 50 lines
fixpanic agent logs --lines=50
# Stream logs in real-time
fixpanic agent logs --follow
# Short form
fixpanic agent logs -f -n 200fixpanic agent validate
Validates the installation and configuration.
fixpanic agent validateChecks for:
- Configuration file existence and validity
- Permission issues
- Network connectivity to the platform
- Agent binary presence
- Required directories
Example output:
✓ Configuration file found
✓ Configuration is valid
✓ Agent binary exists
✓ Network connectivity OK
✓ Permissions OK
Validation passed!fixpanic agent uninstall
Removes the agent, configuration, and logs from the system.
fixpanic agent uninstall [flags]Flags:
| Flag | Description |
|---|---|
--force | Remove without confirmation prompt |
What it removes:
- Agent binary
- Configuration files
- Log files
- Systemd service (if installed)
Danger: This action is irreversible. Make sure you want to completely remove the agent before proceeding.
Example:
# With confirmation prompt
fixpanic agent uninstall
# Skip confirmation
fixpanic agent uninstall --forceCLI Commands
fixpanic upgrade
Updates the CLI tool to the latest available version.
fixpanic upgradeWhat it does:
- Checks GitHub for the latest release
- Downloads the new binary for your platform
- Replaces the current installation
- Preserves all configuration
Example output:
Current version: 1.0.0
Latest version: 1.1.0
Downloading fixpanic v1.1.0...
Upgrade complete!fixpanic --version
Displays the CLI version information.
fixpanic --versionExample output:
fixpanic version 1.0.0 (abc1234)
Built: 2024-01-15fixpanic --help
Displays help information for any command.
# General help
fixpanic --help
# Help for a specific command
fixpanic agent --help
fixpanic agent install --helpCommand Summary
| Command | Description |
|---|---|
fixpanic agent install | Install and configure a new agent |
fixpanic agent status | Check agent status |
fixpanic agent start | Start the agent |
fixpanic agent stop | Stop the agent |
fixpanic agent restart | Restart the agent |
fixpanic agent logs | View agent logs |
fixpanic agent validate | Validate installation |
fixpanic agent uninstall | Remove the agent |
fixpanic upgrade | Update the CLI |
fixpanic --version | Show version |
fixpanic --help | Show help |
Exit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | General error |
2 | Configuration error |
3 | Network/connectivity error |
4 | Permission error |
Next Steps
- Configuration - Learn about configuration files and parameters.
- Troubleshooting - Solutions to common issues.