Resources · Documentation

Documentation

CLI reference

The `prokop` command initializes and operates the local server. Run `prokop help` for the version-specific command list.

On this page

First run

prokop init

Prepare the data directory, run database migrations by default, install the bundled agents, start the daemon, and open the client.

prokop init [options]
Flag Purpose
--db-path <path> Use a custom database path
--run-migrations Run schema migrations, the default behavior
--no-migrations Skip schema migrations
--install-preconfigs Install the bundled agents, the default behavior
--no-preconfigs Skip the bundled agents
--force, -f Force reinitialization

Daemon lifecycle

prokop start

Start Prokop as a background daemon.

prokop start [-p|--port <port>] [-h|--host <host>]

The default bind address is 127.0.0.1:8742, reachable only from this machine. Use prokop remote to share it with other devices.

prokop stop

Stop the background daemon.

prokop stop

prokop restart

Restart the daemon. It accepts the same host and port flags as start.

prokop restart [-p|--port <port>] [-h|--host <host>]

prokop status

Show whether the daemon is running, plus its PID, host, port, and start time.

prokop status

prokop logs

Follow the daemon log. Its default path is ~/.prokopai/server.log.

prokop logs

prokop server

Run the server in the foreground. Use this for service managers or direct debugging.

prokop server [-p|--port <port>] [-h|--host <host>]

Client, devices, and remote access

prokop open

Open the built-in client in your default browser.

prokop open

prokop remote

Show how other devices can reach Prokop, or change it. Changes apply immediately without a restart.

prokop remote                     # show the current addresses
prokop remote on | off            # listen on your network, or only on this computer
prokop remote add <url>           # add a VPN, proxy, or tunnel address
prokop remote remove <url>        # remove an address
prokop remote tailscale on | off  # share over Tailscale HTTPS

prokop pair

Print a QR code, a pairing link, and a one-time code to pair another device. A code works once and expires after 5 minutes.

prokop pair

prokop auth

List paired devices, or remove one. Removing a device closes its open connections immediately.

prokop auth
prokop auth revoke <device-id>

See Security & authentication for remote access setups and pairing.

Models

prokop models sync

Merge new providers and models from the upstream registry while keeping local additions.

prokop models sync

Use --override to replace the local models.json instead:

prokop models sync --override

Database maintenance

prokop migrate

Run pending SQLite schema migrations.

prokop migrate

prokop db stats

Show the database size and how much space can be reclaimed.

prokop db stats

prokop db cleanup

Delete orphaned rows without running SQLite VACUUM.

prokop db cleanup

prokop db vacuum

Delete orphaned rows, checkpoint the write-ahead log, and run SQLite VACUUM to reclaim disk space. Run this during a low-activity period because it requires exclusive database access.

prokop db vacuum

prokop migrate-legacy-data

Move legacy ~/.jean2 data to ~/.prokopai, including nested agent homes and stored workspace paths. Stop every Prokop or Jean2 server first.

prokop stop
prokop migrate-legacy-data

Updates

prokop update

Download and install a Prokop binary release.

prokop update [options]
Flag Purpose
--version <version> Install a specific version instead of latest
--force Reinstall when that version is already present
--dry-run Check for an update without changing the binary
--no-restart Do not restart a running daemon after updating

Utility

Command Purpose
prokop version Print the installed version
prokop help Print commands, options, and examples
prokop <command> --help Show help for commands that expose subcommand help

Default files used by the CLI

These paths move with PROKOPAI_DATA_DIR when it is set.

File Purpose
~/.prokopai/config.json Initialization record and stored database and tools paths
~/.prokopai/models.json Provider and model registry
~/.prokopai/.env Credentials and server settings
~/.prokopai/server.pid Daemon process record
~/.prokopai/server.log Daemon logs

See Configuration for environment variables and server settings.

Spotted something wrong or missing? Open an issue ↗