Skip to content
Scopwis
Reference

CLI / TUI

The scopwis binary provides both command-line workflows and the terminal UI. It uses the same Bootstrap, authentication, Agent, data-source, and report contracts as the Flutter clients.

Endpoint and login

scopwis config get api
scopwis config set api https://api.example.com
scopwis auth login
scopwis auth status
scopwis doctor

Interactive login opens the system browser and stores only the resulting Scopwis session in the operating-system credential store.

Endpoint precedence is:

--api → SCOPWIS_API_BASE → persisted config → http://127.0.0.1:3000

Public endpoints require HTTPS. Loopback HTTP is accepted for local development.

Product commands

scopwis tui
scopwis chat "What data is available?"
scopwis sources
scopwis objects <source_id>
scopwis reports validate examples/specs/sales-dashboard.json

The CLI negotiates capabilities before protected calls. Agent work prefers the task protocol and keeps the same task ID across bounded retries; it does not create a new model task for every transient polling failure.

Diagnostics

scopwis doctor

Doctor checks endpoint resolution, reachability, Bootstrap compatibility, authentication, credential storage, Server/CLI versions, capabilities, and terminal support.

Sign out

scopwis auth logout

Logout asks the Server to revoke the session before removing the local credential. If remote revocation cannot be confirmed, the command does not falsely claim a secure logout.

Type to search the English documentation.