Installation
The documented CLI version requires Node.js 20.9.0 or later and npm. The official package is @scramble-cloud/lurus-code-cli:
Installation changes the global npm environment. Follow your environment’s approval process before running it.
npm install -g @scramble-cloud/lurus-code-cli
lurus --version
lurus --help
lurus doctor
This documentation was checked against source version 2.4.0, not necessarily the version currently published on npm. Follow your environment’s installation approval process. See diagnostics for corporate proxies and certificates.
Authenticate
lurus login
By default, login uses a browser and device code. lurus login --email and lurus login --api-key open alternative interactive input. These flags take no value: do not pass credentials as arguments. Use lurus register to register a new account in the browser. lurus status shows the authentication source and profile.
An explicitly set LURUS_API_KEY environment variable overrides stored credentials. An invalid value does not silently fall back to the stored login. lurus logout removes stored credentials, but does not revoke API keys or remove environment variables.
First project task
Start in the project root:
lurus chat --mode ask
Explain the current architecture. Read relevant files but do not change anything.
/context
Ask blocks ordinary edits, not every process action. Review offered grants/sources/paths rather than blindly approving. For later implementation use /agent <specific task> or /mode agent.
Add project instructions to LURUS.md or use /init. This creates a starting structure and asks the agent to analyze and complete it; it does not immediately produce a finished document. Rules and memory explains paths and loading.
Essential entry points
| Task | Entry |
|---|---|
| Find commands/flags | Complete reference |
| Global/project values | Settings |
| Narrow grants/revocation | Permissions |
| Reusable template | Custom commands |
| Read-only specialist | Custom agents |
| Checklists/packages | Skills |
| Event observation/blocking | Hooks |
| Tasks/plans/sessions | Chat and sessions |
Next steps
Start a custom extension with a minimal file, restart the CLI and check that it appears in the list. Only then add shell commands, global sources or persistent grants. Tests, Git actions, pull requests and media features can change files and make network requests; see workflows. For automated use, see automation and CI/CD.