StavenCTLStavenCTL Doc

CLI Commands

Common commands for managing the StavenCTL Agent.


stavenctl-agent is the primary command-line interface for installing, configuring, and managing a StavenCTL server.

General

CommandDescription
stavenctl-agent --helpShow all available commands.
stavenctl-agent --versionDisplay the installed version.

Agent

CommandDescription
stavenctl-agent agentStart the StavenCTL Agent daemon. Normally started automatically by the stavenctl-agent systemd service.
systemctl status stavenctl-agentShow the agent service status.
systemctl restart stavenctl-agentRestart the agent service.

The installer automatically creates and enables the stavenctl-agent systemd service, so manual execution is usually unnecessary.


Database Migrations

CommandDescription
sudo stavenctl-agent migrationApply all pending database migrations.

Administrator

CommandDescription
sudo stavenctl-agent create-adminCreate or reset the main panel administrator account. Requires root privileges.

License Management

CommandDescription
stavenctl-agent license activateActivate a license key.
stavenctl-agent license verifyVerify the installed license.
stavenctl-agent license statusDisplay the current license status.
stavenctl-agent license clear-cacheRemove the local license cache.

Status

CommandDescription
stavenctl-agent statusDisplay the current StavenCTL Agent status.

Shell Completion

CommandDescription
stavenctl-agent completion bashGenerate Bash completion.
stavenctl-agent completion zshGenerate Zsh completion.
stavenctl-agent completion fishGenerate Fish completion.
stavenctl-agent completion powershellGenerate PowerShell completion.

Typical First-Time Setup

Run the following commands after installing StavenCTL.

sudo stavenctl-agent migration
sudo stavenctl-agent create-admin

Then verify the installation.

sudo systemctl status stavenctl-agent
sudo systemctl status stavenctl-server
sudo systemctl status stavenctl-nginx

stavenctl-agent status
stavenctl-agent license status

On this page