CLI help

The Neuraphic CLI is a command-line tool that lets you interact with the entire Neuraphic ecosystem from your terminal. Instead of switching between browser tabs, you can authenticate, manage Workers, monitor Prion defenses, run Claeth scans, and configure your organization — all through typed commands. It is designed for developers and operators who prefer terminal workflows. The CLI is currently in early development. The command structure and capabilities described here represent the direction we are building toward. See the CLI product page for the full vision.

The CLI installation method depends on your operating system. On macOS and Linux, you will be able to install with a single command: curl -fsSL https://cli.neuraphic.com/install | sh. On macOS, Homebrew support is planned (brew install neuraphic). On Windows, a downloadable installer and winget package are planned. The CLI is in early development — installation methods will be confirmed when the first public release is available. Check the CLI page or Newsroom for announcements.

Run neuraphic auth login in your terminal. The CLI will open your default browser and take you to the Neuraphic sign-in page at accounts.neuraphic.com. After you sign in (including two-factor authentication if enabled), the browser will confirm the connection and the CLI will receive your session credentials automatically. You do not need to copy or paste tokens. To verify your identity afterward, run neuraphic whoami. To sign out, run neuraphic auth logout.

The CLI is organized around product namespaces. Core commands include neuraphic auth (login, logout, whoami), neuraphic workers (list, create, pause, resume, delete), neuraphic prion (status, threats, configure), and neuraphic claeth (scan, report, findings). Run neuraphic --help to see all top-level commands, or neuraphic [command] --help for details on any specific command. Many of these commands are currently in development and will become available as products launch.

The neuraphic workers command group lets you manage your AI employees. Use neuraphic workers list to see all Workers and their status. Create a new Worker with neuraphic workers create --role "content writer". Pause or resume a Worker with neuraphic workers pause [name] and neuraphic workers resume [name]. Worker management via the CLI is currently in development. For now, manage Workers through workers.neuraphic.com.

The CLI will support real-time log streaming for Workers and other services. The planned command is neuraphic workers logs [name] to tail a Worker's output, and neuraphic workers logs [name] --since 1h to view recent history. For Prion and Claeth, similar log commands will be available under their respective namespaces. Log streaming is currently in development. Until then, you can view activity logs through the Console.

The CLI will store its configuration in a file at ~/.neuraphic/config.json (or the equivalent on Windows). This file holds your authentication state, default organization, output format preferences (JSON, table, or plain text), and any product-specific settings. You can edit it directly or use neuraphic config set [key] [value] to modify settings from the command line. The configuration file format is currently being finalized and may change before the first stable release.

When available, you will be able to update the CLI by running neuraphic update. If you installed via Homebrew, brew upgrade neuraphic will also work. The CLI will notify you when a new version is available each time you run a command. We recommend keeping the CLI up to date to ensure compatibility with the latest product features and security patches. The update mechanism is being finalized alongside the initial release.

To uninstall, run neuraphic uninstall which will remove the binary and clean up configuration files. If you installed via Homebrew, use brew uninstall neuraphic. On Windows, use the standard uninstaller or winget uninstall neuraphic. Your Neuraphic account and all product data are not affected by uninstalling the CLI — it only removes the local tool. You can reinstall at any time.

The CLI and Console give you access to the same underlying features through different interfaces. Use the CLI when you prefer keyboard-driven workflows, want to automate tasks with scripts, or need to integrate Neuraphic into CI/CD pipelines. Use the Console when you want a visual overview of your organization, prefer point-and-click management, or need to onboard team members who are less comfortable with terminals. Most teams use both — the Console for day-to-day monitoring and the CLI for automation and quick operations.

If the CLI is not working as expected, start with neuraphic --version to confirm you are running the latest version. Run neuraphic whoami to check your authentication status. If commands are failing, add the --verbose flag to see detailed output. Common issues include expired sessions (re-run neuraphic auth login), network connectivity problems, and outdated CLI versions. If the problem persists, email support@neuraphic.com with the verbose output and your CLI version number.

For CLI-specific issues, email support@neuraphic.com with the subject line "CLI" and include: your operating system and version, CLI version (from neuraphic --version), the command you ran, and the full output with the --verbose flag. You can also visit the Support Center to submit a request. Since the CLI is in early development, your feedback directly shapes priorities — we read every report.