Get started with the orke CLI

Manage sessions, packages, and web pages from a terminal.
Start with commands that read status.

Based on installed help · Options and examplesEnglish

Before using commands

On desktop, start orke first. On a server, serve or the service must be running before you can use management commands. Check the help in your installed version for exact commands.

Readiness and help

orke setup status
orke status
orke help

If the command cannot be found, see the PATH instructions in CLI setup. You may need to open a new terminal after applying the path setting.

First example: read running tasks

Terminal

orke session list --json
orke session status --id "SESSION_ID" --json
orke session screen --id "SESSION_ID" --json

Replace SESSION_ID with an actual ID returned by list. Do not use the example placeholder as an ID.

Find the command you need

Task	Command group
Create sessions · Output · Input · End	session
Author packages · Save · Run · Repeat	package
List AI employees · Start shifts · Instruct · Handle requests	employee
Web pages · Input · Downloads · Profiles	browser
Paths · AI guides · Server browser	setup
Linux operations · Remote access · Update · Remove	Server commands

All commands

This reference collects 108 canonical invocations checked against the current code and help. Open a command to see its syntax, required and optional options, examples, and operating conditions.

View all commands →

Read JSON and failure results

Management command JSON uses version: 2, while browser JSON uses version: 1. Read ok and error together, and check whether a failure’s data contains a created ID or completed steps.

Do not immediately repeat a request just because no answer arrived

If outcomeUnknown: true, the action may already have run. Read its status and actual result before deciding what to do next.