Skip to content

cli.md

Latest commit

 

History

History
222 lines (180 loc) · 8.42 KB

cli.md

File metadata and controls

222 lines (180 loc) · 8.42 KB
Raw

Kylrix CLI (@kylrix/cli)

The official command-line interface, local-first SQLite engine, Model Context Protocol (MCP) bridge, and isomorphic TypeScript SDK for Kylrix.

⚡ 30-Second Quickstart

1. Install Globally (Offline Local-First)

npm install -g @kylrix/cli

(or via pnpm)

pnpm add -g @kylrix/cli

2. Run Directly from Terminal

1-Click Web Authorization (Cloud or Custom Base URI):

# Cloud login
kylrix login

# Self-hosted or custom backend base URI
kylrix login --url http://localhost:3005

Manage Accounts & Backend Base URIs:

# List accounts on active server
kylrix accounts list

# Switch between accounts seamlessly
kylrix accounts switch user@example.com

# Switch backend base URI / partition
kylrix server list
kylrix server switch http://localhost:3005

Create a sovereign idea:

kylrix ideas create "Launch Kylrix v1"

List ideas:

kylrix ideas list

Start stdio MCP Server for AI coding agents (Cursor / Claude / Windsurf):

kylrix mcp

(Zero-install alternative: run with npx @kylrix/cli <command>)

🛡️ Architecture & Key Features

1. Partitioned Silos & True Local-First (Embedded SQLite)

  • Base URI Partitioning: Local databases and configuration are strictly partitioned by backend base URI. Kylrix Cloud is isolated under the default partition (~/.kylrix/silos/default/), while self-hosted instances (http://localhost:3005, https://selfhost.company.internal) are partitioned into their own directory silos (~/.kylrix/silos/<partitionKey>/).
  • Multi-Account Silos: Within each base URI partition, accounts are isolated into separate silos (~/.kylrix/silos/<partitionKey>/<userId>/). Switching accounts (kylrix accounts switch <email>) immediately routes local storage to that user's silo without data bleed.
  • Zero Login Required: Offline local-first state runs out of the anonymous silo (~/.kylrix/silos/default/anonymous/local.db) without creating an account.
  • Sync When Ready: Once authenticated (kylrix login), running kylrix sync synchronizes your silo's local records up to the active cloud or self-hosted workspace.

2. 1-Click Web Login & Pairing

  • Running kylrix login (or kylrix login --url <url>) initiates RFC 8628 pairing and opens /login/7K9M-4W2P in your browser on the target server.
  • Clicking "Authorize" in the web workspace logs your CLI session in instantly with zero manual token copying, registering the account in the server's partition.

3. Bitwarden-Style Encrypted Vault & 2FA TOTP

  • kylrix vault unlock: Prompts for your Master Password (or accepts --password), derives your Master Encryption Key (MEK), and holds a transient session.
  • kylrix vault list --decrypt / get <id> --pure > .env: Seamlessly decrypts secrets and exports project environment variables.
  • kylrix vault lock: Immediately wipes keys from memory.
  • kylrix totp list / code <id>: Generates real-time 6-digit TOTP verification codes with countdowns.

4. Model Context Protocol (MCP) Stdio Server

Bridge your sovereign Kylrix workspace into Cursor, Windsurf, or Claude Code:

{
  "mcpServers": {
    "kylrix": {
      "command": "npx",
      "args": ["-y", "@kylrix/cli", "mcp"],
      "env": {
        "KYLRIX_API_KEY": "pat_..."
      }
    }
  }
}

📋 Command Catalog

Authentication & Multi-Account

Command Description
kylrix login 1-Click web login & browser pairing (--url <url>, --token <token>)
kylrix pair Authenticate with RFC 8628 code (--url <url>)
kylrix whoami (alias me) Display active identity, email, base URI, partition, and silo path
kylrix logout Remove stored local authentication tokens (--all, --purge)
kylrix accounts list (alias ls) List accounts under current base URI (--all across all servers)
kylrix accounts switch <id/email> Switch active account profile for the current base URI
kylrix accounts current Show currently active account profile
kylrix accounts remove <id/email> Remove an account profile from local config
kylrix server list (alias ls) List configured backend base URIs, partitions, and account counts
kylrix server switch <url> Switch active backend base URI
kylrix server current Print currently active base URI and partition
kylrix server add <url> Register a backend base URI
kylrix server remove <url> Remove a backend base URI
kylrix settings View account configuration and limits
kylrix admin Verify server status and Edge Shield health

Workspace Management

Command Description
kylrix workspaces list List all accessible workspaces
kylrix workspaces get <id> View workspace details
kylrix workspaces create <name> Create a new workspace
kylrix workspaces switch <id> (alias use) Set active default workspace for all commands
kylrix workspaces current Print currently active workspace
kylrix workspaces clear Reset back to Personal Virtual Workspace
kylrix workspaces delete <id> Delete a workspace

Ideas & Articles

Command Description
kylrix ideas list List sovereign ideas and notes
kylrix ideas get <id> View idea content
kylrix ideas create <title> Create a new idea (--content, --category, --tags)
kylrix ideas update <id> Update idea title or content
kylrix ideas delete <id> Soft-delete an idea to trash
kylrix ideas articles Filter long-form published articles

Goals & Milestones

Command Description
kylrix goals list List goals and progress (--status)
kylrix goals get <id> Inspect goal milestones and target
kylrix goals create <title> Create a goal (--target, --unit)
kylrix goals update <id> Update progress (--progress 75) or status
kylrix goals delete <id> Delete a goal

Encrypted Vault & Secrets

Command Description
kylrix vault unlock Unlock Master Encryption Key (MEK)
kylrix vault lock Seal vault and wipe keys from memory
kylrix vault status Check if vault is locked or unlocked
kylrix vault list List credentials (--decrypt to unseal)
kylrix vault get <id> View secret (--format env --pure for dotenv)
kylrix vault create <name> Add secret or import --env-file .env
kylrix vault delete <id> Delete a secret

2FA TOTP Authenticator

Command Description
kylrix totp list List accounts with live 6-digit codes
kylrix totp code <id> Output raw 6-digit code for pipes/clipboard
kylrix totp create <name> Add TOTP secret key (--secret <base32>)
kylrix totp delete <id> Remove TOTP seed

AI Agents & Search

Command Description
kylrix agents list List autonomous agent execution sessions
kylrix agents get <id> View agent execution logs and transcript
kylrix agents start <title> Launch autonomous agent session (--prompt)
kylrix search <query> Global search across ideas, goals, events, secrets
kylrix share <kind> <id> Generate shareable link

Calendar, Forms, Flows & Hangouts

Command Description
kylrix events list/create/delete Calendar events and schedules
kylrix forms list/get/create/delete Interactive forms
kylrix flows list/get/create/delete Workflow automation pipelines
kylrix hangouts list/messages/send Real-time discussions and messages
kylrix threads list/messages/send Discussion threads on workspace objects
kylrix tags list/create/delete Sovereign tagging system
kylrix trash list/restore/purge Soft-deleted item recovery

Sync & Self-Update

Command Description
kylrix sync Synchronize local SQLite records to Kylrix Cloud
kylrix update (alias upgrade) Auto-upgrade CLI to latest published version

💻 Programmatic SDK Usage

import { createKylrixClient } from '@kylrix/cli';

const client = createKylrixClient({
  baseUrl: 'https://www.kylrix.space',
  token: 'pat_...',
});

// Search across workspace
const results = await client.search.query('architecture');

// Create goal
const goal = await client.goals.create({
  title: 'Ship v1.0.0 CLI',
  targetValue: 100,
  unit: '%',
});

📜 License

AGPL-3.0-or-later © Kylrix