auth
Usage: deepline auth [options] [command]
Register this device and show CLI auth status.
Options:
-h, --help display help for command
Commands:
register [options] Register this device and open the approval page in your
browser.
wait [options] Wait for a pending browser approval and save the API key.
status [options] Show the current CLI auth and workspace status.
help [command] display help for command
auth register
Usage: deepline auth register [options]
Register this device and open the approval page in your browser.
Options:
--org-name <name> Connect to an existing workspace, or name your first
workspace
--org-id <id> Bind to this workspace directly, skipping the browser
picker
--agent-name <name> Agent name to register
--wait <mode> Wait mode: auto, yes, or no (default: "auto")
--no-wait Alias for --wait no
--auth-scope <scope> Credential scope: global or folder (default: "global")
-h, --help display help for command
Explanation:
Purpose:
Start a device-style login: it prints an approval URL, and once a person
approves it in a browser the shell receives a workspace API key.
When:
Only in an interactive session where a person can open the URL. Never in an
unattended agent shell: the command has nothing to do until a human acts.
Input:
No arguments. It opens the approval page and waits for approval; keep that
default. In Cowork it prints the link and returns, and auth wait finishes
the login.
Output:
The approval URL and, after approval, the connected workspace.
Cost:
Free.
Avoid:
If auth status says connected false and you cannot open a browser, report
that Deepline is not connected and stop.
auth wait
Usage: deepline auth wait [options]
Wait for a pending browser approval and save the API key.
Options:
--timeout <seconds> Maximum seconds to wait (default: "300")
--auth-scope <scope> Credential scope: global or folder (default: "global")
-h, --help display help for command
Explanation:
Purpose:
Poll a pending auth register approval until it completes or times out.
When:
After auth register returned before approval, as it does in Cowork, and a
person is approving it in a browser.
Input:
No arguments beyond the pending registration it finds locally.
Output:
The connected workspace once approved; a timeout error otherwise.
Cost:
Free.
auth status
Usage: deepline auth status [options]
Show the current CLI auth and workspace status.
Options:
--reveal Persist the revealed API key back to the host auth file
--auth-scope <scope> Read only folder or global auth
--json Emit JSON output
-h, --help display help for command
Explanation:
Purpose:
Report which Deepline host, workspace, and user this shell is authenticated
as, without changing anything.
When:
When you need the workspace name or id, or to confirm auth after a 3 exit
code.
Input:
No arguments. --auth-scope folder|global reads one auth store only.
--reveal persists the API key into the local auth file; do not use it.
Output (JSON):
host, hostStatus, status ("claimed" when authenticated), connected
(boolean), workspace {id, name, slug}, user {id}, render.sections.
Cost:
Free.
Avoid:
connected false in an unattended shell is a stop-and-report condition, not
a prompt to run auth register.