Routine commands

Run your platform's executable from the bundle folder. Keep any custom --state-root path printed by setup.

Example: installation status
Windows · PowerShell
.\backloggo-setup-windows-amd64.exe status
macOS · Terminal
./backloggo-setup-darwin-arm64 status
Linux · Terminal
./backloggo-setup status

Add these subcommands after that executable:

SubcommandUse
statusCheck installation status.
doctorCheck the installation and agent environment.
logs --tail 100Read recent logs. Add --follow to keep watching.
stop / startStop or restart the saved installation.
projectResume setup, change settings, or add a project.
loginSign in to Codex.

Updates and rollback

Finish active work first. Use the target release's verified bundle and your saved installation location.

Upgrade to a published version
Windows · PowerShell
.\backloggo-setup-windows-amd64.exe upgrade --release VERSION
macOS · Terminal
./backloggo-setup-darwin-arm64 upgrade --release VERSION
Linux · Terminal
./backloggo-setup upgrade --release VERSION

Replace VERSION with the published version. Upgrade preserves settings and saves a database copy before migration. If it fails, check status and follow the reported recovery action.

Rollback
Windows · PowerShell
.\backloggo-setup-windows-amd64.exe rollback
macOS · Terminal
./backloggo-setup-darwin-arm64 rollback
Linux · Terminal
./backloggo-setup rollback

Backups

Your database, credentials and license are stored outside the application container. They remain in place when you update BacklogGo.

There is no automatic backup service. Stop BacklogGo, then back up its persistent storage: database and project data, provider credentials, Codex login state, and licenses. Keep the matching image identity and saved setup files, and verify the backup.

Restore with the matching runtime into empty destination storage. Keep the original stopped so two copies cannot act on the same board. Deleting the database or recreating storage is not a repair.

Buy a license

Already using the free version? Choose a plan, then enter your installation ID when asked.

Run this on the machine where BacklogGo is running. Copy installation_id from the result into the purchase form:

Use your installation's address. The examples use the default port, 8787. If yours differs, use the Local API address printed by status and keep /api/license.

Get installation ID and license status
Windows · PowerShell
Invoke-RestMethod -Method Get -Uri "http://127.0.0.1:8787/api/license"
macOS · Terminal
curl --fail-with-body "http://127.0.0.1:8787/api/license"
Linux · Terminal
curl --fail-with-body "http://127.0.0.1:8787/api/license"

After purchase, download the file and install your license. After each successful renewal, download the renewed file from your website account and replace it in the same location.

Install a license file

After purchase, download your signed license file as backloggo.license.

Copy the downloaded file into your installation's persistent license volume, named backloggo-mvp-v1-license by default. The copy command below uses the stable internal filename shared with older releases, so upgrades and rollback keep the same license.

Existing installations keep their original volume name. Find the setting ending in LICENSE_VOLUME in setup/settings.json under the Data folder printed by status.

Finish active work, then stop your installation:

Stop before installing a license
Windows · PowerShell
.\backloggo-setup-windows-amd64.exe stop
macOS · Terminal
./backloggo-setup-darwin-arm64 stop
Linux · Terminal
./backloggo-setup stop

Copy the file to that license volume using the command below. To renew or change plans, replace the file in the same location. Your license and database storage stay in place when upgrading.

Copy the file from a terminal

From the folder containing backloggo.license, find the container using your license volume. Substitute your volume name below if you changed it during setup:

Find the installed container
docker ps -a --filter "volume=backloggo-mvp-v1-license" --filter "label=com.docker.compose.service=agent-run" --format "{{.Names}}"

Replace CONTAINER_NAME with the name for this installation. The destination below is the mounted license volume. On macOS and Linux, the first command makes the file readable by BacklogGo.

Copy into the license volume
Windows · PowerShell
docker cp .\backloggo.license CONTAINER_NAME:/run/agent-run/license/agent-run.license
macOS · Terminal
chmod 644 ./backloggo.license
docker cp ./backloggo.license CONTAINER_NAME:/run/agent-run/license/agent-run.license
Linux · Terminal
chmod 644 ./backloggo.license
docker cp ./backloggo.license CONTAINER_NAME:/run/agent-run/license/agent-run.license

Start the installation again:

Start after installing a license
Windows · PowerShell
.\backloggo-setup-windows-amd64.exe start
macOS · Terminal
./backloggo-setup-darwin-arm64 start
Linux · Terminal
./backloggo-setup start

Run the license status command again.

Confirm that state is valid or expiring and capacity_limit matches your plan. If not, follow next_action or ask for help. Keep license files out of public reports.

See Models and licenses for free capacity and offline verification.