Commands for standing up and operating a deployment, plus local configuration. To deploy your own environment end to end, follow the quickstart.

​
setup

Configure, deploy, and tear down a Forkr environment 
4kr setup <command>
SubcommandDescription
statusPrint setup progress from .forkr/setup-state.json
checkCheck local commands and required setup config
uiOpen a local setup status UI
installCheck/install host dependencies for a deployment host
bundlePrepare a deploy bundle under .forkr/repo
secretsCreate infra/secrets/<profile>.sops.yaml from configured input files and setup secrets
deployRun deployment from the configured setup state
destroyDestroy deployment infrastructure for the configured setup state
github-appCreate a deployment-scoped GitHub App via GitHub’s manifest flow
agentPrint concise setup context for coding agents
guidePrint agent-facing setup guidance
# Show setup progress and missing requirements
4kr setup status
4kr setup check

# Open the local setup UI
4kr setup ui

# Install/check host dependencies before deploy
4kr setup install

# Prepare repo-free deploy bundle
4kr setup bundle

# Create encrypted deploy secrets from configured input files
4kr setup secrets

# Deploy the selected profile
4kr setup deploy

# Print concise setup context for coding agents
4kr setup agent

# Destroy the selected profile VM
4kr setup destroy --yes

# Print the agent-facing setup guide
4kr setup guide

​
status

Print setup progress from .forkr/setup-state.json 
4kr setup status [options]
Argument / optionDescription
--jsonPrint the JSON response.

​
check

Check local commands and required setup config 
4kr setup check [options]
Argument / optionDescription
--jsonPrint the JSON response.

​
ui

Open a local setup status UI 
4kr setup ui [options]
Argument / optionDescription
--port <PORT>Defaults to 4874.
--host <HOST>Defaults to 127.0.0.1.
--no-openPrint the URL instead of opening a browser.

​
install

Check/install host dependencies for a deployment host 
4kr setup install [options]
Argument / optionDescription
--dry-runPrint what would happen without running installers
-y, --yesRun supported installers without prompting

​
bundle

Prepare a deploy bundle under .forkr/repo 
4kr setup bundle [options]
Argument / optionDescription
-f, --forceReplace an existing deploy bundle
--downloadDownload source bundle instead of copying the current repo
--url <URL>Source tarball URL. Defaults to FORKR_SETUP_BUNDLE_URL or the repository main tarball

​
secrets

Create infra/secrets/<profile>.sops.yaml from configured input files and setup secrets 
4kr setup secrets [options]
Argument / optionDescription
--dry-runPrint the target secrets path without writing
-f, --forceReplace an existing secrets file

​
deploy

Run deployment from the configured setup state 
4kr setup deploy [options]
Argument / optionDescription
--dry-runPrint the deploy command without running it
--skip-verifySkip post-deploy verification

​
destroy

Destroy deployment infrastructure for the configured setup state 
4kr setup destroy [options]
Argument / optionDescription
--dry-runPrint the destroy command without running it
-y, --yesDestroy without prompting

​
github-app

Create a deployment-scoped GitHub App via GitHub’s manifest flow 
4kr setup github-app [options]
Argument / optionDescription
--name <NAME>GitHub App name. Defaults to “Forkr <profile>“
--owner <OWNER>GitHub organization login. Omit to choose personal or organization in the browser
--port <PORT>Local callback port for GitHub’s manifest redirect. Defaults to 4875.
--no-openDo not open the browser automatically; print the local HTML path instead
--code <CODE>Convert an already received GitHub App manifest code instead of starting a callback server
--print-manifestPrint the manifest JSON without contacting GitHub
--deployAfter storing GitHub App credentials, redeploy only forkr-api for this profile
# Choose personal or organization in the browser, then redeploy only forkr-api
4kr setup github-app --deploy

# Skip the browser choice and create the GitHub App under an organization
4kr setup github-app --owner example-org --deploy

# Print the manifest without contacting GitHub
4kr setup github-app --print-manifest

​
agent

Print concise setup context for coding agents 
4kr setup agent

​
guide

Print agent-facing setup guidance 
4kr setup guide

​
config

Read and write local setup config 
4kr config <command>
SubcommandDescription
pathPrint the local setup config path
profilesList known setup profiles and the selected default
listList all stored setup config
getRead one setup config value
setSet one setup config value
unsetRemove one setup config value
# Set setup values used by setup UI/install/deploy
4kr config set profile example
4kr config set forkr_domain 4kr.dev
4kr config set publish_domain 4kr.ai

# Read setup config
4kr config list
4kr config get profile
4kr config path

​
path

Print the local setup config path 
4kr config path

​
profiles

List known setup profiles and the selected default 
4kr config profiles [options]
Argument / optionDescription
--jsonPrint the JSON response.

​
list

List all stored setup config 
4kr config list [options]
Argument / optionDescription
--jsonPrint the JSON response.

​
get

Read one setup config value 
4kr config get <KEY>
Argument / optionDescription
<KEY>Config key.

​
set

Set one setup config value 
4kr config set <KEY> <VALUE>
Argument / optionDescription
<KEY>Config key.
<VALUE>Config value.

​
unset

Remove one setup config value 
4kr config unset <KEY>
Argument / optionDescription
<KEY>Config key.

​
health

Report API and cluster health 
4kr health [options]
Argument / optionDescription
-j, --jsonPrint the JSON response.
4kr health
4kr health --json

​
upgrade

Upgrade the 4kr CLI to the version served by the API 
4kr upgrade [options]
Argument / optionDescription
--dry-runPrint selected release artifact without installing
# Upgrade 4kr from the configured API endpoint
4kr upgrade

# Upgrade to a specific CLI version served by the API
4kr upgrade --version 0.2.0

# Preview the selected artifact
4kr upgrade --dry-run

​
project

Inspect project resolution 
4kr project <command>
SubcommandDescription
currentShow the current resolved project name
4kr project current

​
current

Show the current resolved project name 
4kr project current

​
docs

Print the “Using forkr” guide 
4kr docs