XMemo CLI

https://github.com/yonro/memory-os-cli
Admin
XMemo CLI is a privacy-first command-line tool and MCP setup helper that connects AI agents,...
Tokens:12,212
Snippets:213
Trust Score:6.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and Initialize XMemo CLI

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Global installation of the client followed by authentication, system diagnostics, and initial setup.

```bash
npm install -g @xmemo/client
xmemo login
xmemo doctor
xmemo setup codex
xmemo status
```

--------------------------------

### Client Setup Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Commands for configuring specific clients or all clients at once.

```bash
xmemo setup <client>
xmemo setup <client> --dry-run
xmemo setup --all
xmemo setup openclaw [--with-mcp|--mcp-only]
xmemo setup hermes [--with-mcp|--mcp-only]
```

--------------------------------

### Install XMemo CLI

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Installs the XMemo client globally via npm.

```bash
npm install -g @xmemo/client
```

--------------------------------

### Client Setup Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Commands to configure various AI clients for use with Memory OS.

```bash
xmemo setup codex
```

```bash
xmemo setup cursor
```

```bash
xmemo setup copilot
```

```bash
xmemo setup gemini
```

```bash
xmemo setup antigravity
```

```bash
xmemo setup openclaw
```

```bash
xmemo setup hermes
```

```bash
xmemo setup kiro
```

```bash
xmemo setup grok
```

```bash
xmemo mcp config --client generic
```

```bash
xmemo mcp list
```

--------------------------------

### Test Client Configuration

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Verify the client setup using dry-run commands before applying changes.

```bash
# Test config generation
xmemo mcp add foobar --dry-run

# Test setup wizard
xmemo setup foobar --dry-run

# Actually configure
xmemo setup foobar
```

--------------------------------

### Preview Configuration Changes

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Perform a dry-run of the setup process to preview configuration changes before applying them.

```bash
xmemo setup cursor --dry-run
```

--------------------------------

### Native Integration Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Setup commands for native memory providers and optional MCP fallbacks.

```bash
# Native OpenClaw plugin + XMemo Skill
xmemo setup openclaw

# Native Hermes memory provider
xmemo setup hermes
```

```bash
xmemo setup openclaw --with-mcp
xmemo setup hermes --with-mcp
```

--------------------------------

### Generate Manual Configuration

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/POWER.md

Advanced commands for generating configuration snippets or previewing the setup process.

```bash
xmemo mcp config --client kiro --json
```

```bash
xmemo setup kiro --dry-run
```

--------------------------------

### View environment and privacy configuration

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Use these commands to inspect environment variable examples and privacy settings.

```bash
xmemo env example --shell bash
xmemo privacy
```

--------------------------------

### Configure OpenClaw Client

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Installs the required memory package and XMemo skill, then verifies plugin status.

```bash
xmemo login
xmemo setup openclaw
openclaw xmemo status
```

--------------------------------

### Run development and release commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Standard commands for installing dependencies, linting, testing, and verifying package integrity.

```bash
npm install
npm run release:check
npm run lint
npm test
npm run pack:dry-run
```

--------------------------------

### Run CLI Verification Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Execute these commands to verify client configuration generation, setup wizard functionality, and auto-detection logic without making permanent changes.

```bash
npm test
```

```bash
xmemo mcp add <client-id> --dry-run
```

```bash
xmemo setup <client-id> --dry-run
```

```bash
xmemo setup --all --dry-run
```

--------------------------------

### Configure XMemo MCP manually

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/xmemo/README.md

Use this command for local or manual installations where Cursor OAuth is unavailable.

```bash
xmemo mcp config --client cursor --json
```

--------------------------------

### Install XMemo for Kiro

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/POWER.md

Run this command to merge the XMemo MCP server configuration into Kiro's settings.

```bash
xmemo setup kiro
```

--------------------------------

### Configure Codex and Cursor Clients

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Sets up user-scoped MCP entries for Codex and Cursor. Use the --no-profile flag to skip memory behavior profile installation.

```bash
xmemo setup codex
xmemo smoke --client codex

xmemo setup cursor
```

--------------------------------

### Verify XMemo Installation

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Commands to inspect the MCP configuration file and check authentication status.

```bash
cat ~/.kiro/settings/mcp.json
```

```bash
xmemo auth status
xmemo token status --verify
```

--------------------------------

### Handle Duplicate MCP Entry Error

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Example of the error message displayed when duplicate server entries exist.

```text
MCP config already contains mcpServers.XMemo
```

--------------------------------

### Configure Gemini and Antigravity Clients

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Configures clients using hosted MCP OAuth. Requires a browser login upon first use after restarting the client.

```bash
xmemo setup gemini
xmemo setup antigravity
```

--------------------------------

### Access CLI Help Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Use these commands to view built-in help documentation for the XMemo CLI.

```bash
xmemo --help
```

```bash
xmemo setup --help
```

--------------------------------

### Troubleshoot Connection and Configuration

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/POWER.md

Commands to verify authentication status and inspect the current MCP configuration file.

```bash
xmemo auth status
xmemo token status --verify
```

```bash
cat ~/.kiro/settings/mcp.json
```

--------------------------------

### Manual local publishing

Source: https://github.com/yonro/memory-os-cli/blob/main/extensions/vscode/PUBLISHING.md

Commands to build, package, and publish the extension manually from the local environment.

```bash
cd extensions/vscode
npm install
npm run build
npx @vscode/vsce package --no-dependencies -o xmemo-vscode.vsix   # validate the .vsix
npx @vscode/vsce publish --no-dependencies                        # → Marketplace (needs VSCE_PAT env or login)
npx ovsx publish xmemo-vscode.vsix --pat <OVSX_TOKEN>             # → Open VSX
```

--------------------------------

### Authenticate via Browser

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Initiate the device-login flow for personal accounts and verify authentication status.

```bash
xmemo login
xmemo auth status
```

--------------------------------

### Authentication Reference Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Reference for authentication and token management commands.

```bash
xmemo login
xmemo auth status
xmemo auth-status --verify
xmemo token status --verify
xmemo token add --from-stdin --allow-plaintext
xmemo env example --shell bash
```

--------------------------------

### Configure Kiro MCP

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Commands to preview or apply the XMemo configuration for Kiro.

```bash
xmemo setup kiro --dry-run
```

```bash
xmemo setup kiro
```

--------------------------------

### Run package gate check

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Executes the full suite of checks required before proposing a release.

```bash
npm run prepublishOnly
```

--------------------------------

### Configure Hermes Client

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Synchronizes user-scoped XMemo credentials with the Hermes native provider.

```bash
xmemo login
xmemo setup hermes
```

--------------------------------

### Register Temporary Sandbox

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Create a limited temporary sandbox for environments where formal login is unavailable.

```text
node scripts/xmemo-skill.mjs register --reason unattended --allow-plaintext
```

--------------------------------

### Define Default Config Path Function

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Create a function to return the default configuration file path for the new client.

```javascript
export function defaultYourClientConfigPath(env) {
  const home = env.USERPROFILE || env.HOME || os.homedir();
  return path.join(home, '.your-client', 'mcp.json');
}
```

```javascript
export function defaultYourClientConfigPath(env) {
  if (process.platform === 'win32' && env.APPDATA) {
    return path.join(env.APPDATA, 'YourClient', 'mcp.json');
  }
  const home = env.HOME || os.homedir();
  if (process.platform === 'darwin') {
    return path.join(home, 'Library', 'Application Support', 'YourClient', 'mcp.json');
  }
  return path.join(home, '.config', 'your-client', 'mcp.json');
}
```

--------------------------------

### Local stdio MCP Execution

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Commands and configuration for running the local stdio MCP entry point.

```bash
xmemo-mcp
```

```json
{
  "mcpServers": {
    "XMemo": {
      "command": "npx",
      "args": [
        "-y",
        "--package",
        "@xmemo/client@latest",
        "xmemo-mcp"
      ]
    }
  }
}
```

```bash
xmemo mcp serve
```

--------------------------------

### Configure Custom Service URL

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Use this command to point the Kiro plugin to a self-hosted or enterprise XMemo instance.

```bash
xmemo setup kiro --url https://your-xmemo-instance.example.com
```

--------------------------------

### Add Credentials via CLI

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Commands for adding credentials using device login or stdin, requiring the --allow-plaintext flag for local storage.

```text
node scripts/xmemo-skill.mjs login --allow-plaintext
# or
printf '%s' "$XMEMO_KEY" | node scripts/xmemo-skill.mjs auth add --from-stdin --allow-plaintext
```

```powershell
$env:XMEMO_KEY | node scripts/xmemo-skill.mjs auth add --from-stdin --allow-plaintext
```

--------------------------------

### Define Default Configuration Path

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Implement a function to resolve the client's configuration file path based on the user's home directory.

```javascript
export function defaultFoobarConfigPath(env) {
  const home = env.USERPROFILE || env.HOME || os.homedir();
  return path.join(home, '.foobar', 'config.json');
}
```

--------------------------------

### Register Client Definition

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Add the new client to the JSON_MCP_CLIENT_DEFINITIONS array with its specific configuration requirements.

```javascript
export const JSON_MCP_CLIENT_DEFINITIONS = Object.freeze([
  // ... existing definitions ...
  httpClientDefinition('your-client', 'Your Client', 'defaultYourClientConfigPath', { 
    urlKey: 'url', 
    authentication: 'env-bearer' 
  }),
]);
```

--------------------------------

### Check MCP Configuration

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Verify the contents of the Kiro MCP settings file.

```bash
cat ~/.kiro/settings/mcp.json
```

--------------------------------

### Configure Copilot CLI

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Sets up a local proxy to forward requests to hosted MCP without storing secrets in the Copilot configuration.

```bash
xmemo login
xmemo setup copilot
xmemo mcp proxy
```

--------------------------------

### Inspect local stdio server

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Directly executes the stdio server binary for inspection.

```bash
node bin/mcp-stdio.js
```

--------------------------------

### Create Open VSX namespace

Source: https://github.com/yonro/memory-os-cli/blob/main/extensions/vscode/PUBLISHING.md

Claim the namespace on Open VSX using the ovsx CLI tool.

```bash
npx ovsx create-namespace xmemo --pat <OVSX_TOKEN>
```

--------------------------------

### Authenticate XMemo

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/POWER.md

Authenticate the CLI and set the required environment variable for Kiro.

```bash
xmemo login
```

```bash
# PowerShell (User-level, persistent)
$token = xmemo token show --format raw
[Environment]::SetEnvironmentVariable("XMEMO_KEY", $token, "User")

# PowerShell (Session-only)
$env:XMEMO_KEY = xmemo token show --format raw

# Bash/Zsh
export XMEMO_KEY=$(xmemo token show --format raw)
```

--------------------------------

### Lifecycle and Diagnostics Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Commands for checking versions, updating the CLI, and running diagnostic checks.

```bash
xmemo --version
xmemo update
xmemo update --dry-run
xmemo doctor
xmemo discovery show
xmemo status
xmemo privacy
```

--------------------------------

### Authenticate XMemo

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/README.md

Initial login command for the XMemo CLI.

```bash
xmemo login
```

--------------------------------

### XMemo CLI Command Reference

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/SKILL.md

Standard CLI commands for managing authentication, session status, and system health.

```text
node scripts/xmemo-skill.mjs auth status [--verify]
node scripts/xmemo-skill.mjs auth add --from-stdin --allow-plaintext
node scripts/xmemo-skill.mjs auth claim-status [--allow-plaintext]
node scripts/xmemo-skill.mjs auth claim-confirm [--allow-plaintext]
node scripts/xmemo-skill.mjs auth claim-deny [--allow-plaintext]
node scripts/xmemo-skill.mjs logout [--revoke-environment-token]
node scripts/xmemo-skill.mjs doctor
```

--------------------------------

### Manage XMemo TODOs

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Create or list tasks within XMemo.

```text
Create a TODO in XMemo to refactor the auth module next week
List my XMemo TODOs
```

--------------------------------

### Verify Release Versions

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Command to verify the version contracts for both the CLI and the hosted MCP service.

```bash
node scripts/check-release-version.mjs
```

--------------------------------

### Configure MCP for Kiro

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/README.md

Generates the manual configuration for the Kiro client in JSON format.

```bash
xmemo mcp config --client kiro --json
```

--------------------------------

### MCP and Behavior Profile Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Commands for managing MCP servers and behavior profiles.

```bash
xmemo mcp serve
xmemo mcp list
xmemo mcp config --client generic
xmemo mcp add <client> --write
xmemo mcp proxy
xmemo profile install <client>
xmemo profile status <client>
xmemo profile uninstall <client>
xmemo smoke --client codex
```

--------------------------------

### Configure XMemo MCP Server

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

JSON configuration structure for the XMemo MCP server.

```json
{
  "mcpServers": {
    "XMemo": {
      "url": "https://xmemo.dev/mcp",
      "headers": {
        "Authorization": "Bearer ${env:XMEMO_KEY}",
        "X-Memory-OS-Agent-ID": "kiro",
        "X-Memory-OS-Agent-Instance-ID": "${XMEMO_AGENT_INSTANCE_ID}"
      }
    }
  }
}
```

--------------------------------

### Add Direct Token to XMemo

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Adds a pre-existing token to the store using standard input.

```bash
printf '%s\n' 'your-token' | xmemo token add --from-stdin --allow-plaintext
```

--------------------------------

### Define a Command Client

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Registers a client using mcp-remote command-based transport.

```javascript
commandClientDefinition('client-id', 'Client Label', 'defaultConfigPathFunction')
```

--------------------------------

### Execute XMemo CLI Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/SKILL.md

A list of available commands for the xmemo-skill.mjs script to manage memory, tasks, and diagnostics.

```text
node scripts/xmemo-skill.mjs remember --content "..." --path "..."
node scripts/xmemo-skill.mjs recall --query "..." --compact
node scripts/xmemo-skill.mjs search --query "..." --limit 5 --compact
node scripts/xmemo-skill.mjs save-state --key active_task
node scripts/xmemo-skill.mjs restore-state --key active_task
node scripts/xmemo-skill.mjs restart-snapshot
node scripts/xmemo-skill.mjs restart-restore
node scripts/xmemo-skill.mjs todo-add --content "..."
node scripts/xmemo-skill.mjs todo-list
node scripts/xmemo-skill.mjs todo-done --id <todo_id>
node scripts/xmemo-skill.mjs expense-add --item "..." --amount 12.5 --currency USD
node scripts/xmemo-skill.mjs doctor
node scripts/xmemo-skill.mjs doctor --anonymous
node scripts/xmemo-skill.mjs register --reason <unattended|declined> --allow-plaintext
```

--------------------------------

### Verify XMemo Skill Script

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Run the doctor command to ensure the script is executable and configured correctly.

```text
node scripts/xmemo-skill.mjs doctor
```

--------------------------------

### CLI Release Workflow

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

The sequence of events for producing a normal release via GitHub Actions.

```text
develop → CLI version sync → test → cli-v tag → GitHub Actions → npm publish --provenance
```

--------------------------------

### Manage restart snapshots

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Captures or restores full session continuity snapshots.

```text
node scripts/xmemo-skill.mjs restart-snapshot
node scripts/xmemo-skill.mjs restart-restore
```

```text
node scripts/xmemo-skill.mjs restart-snapshot --session_id handoff-a --timeline_limit 20
node scripts/xmemo-skill.mjs restart-restore --source_session_id handoff-a --target_session_id handoff-b
```

--------------------------------

### View npm package file structure

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Lists of files included and excluded from the npm package distribution.

```text
bin/
docs/assets/
src/
skills/
plugins/kiro/
plugins/xmemo/
README.md
LICENSE
```

```text
.github/
docs/analysis/
docs/architecture/
test/
coverage/
server code
database migrations
deployment files
logs and local state
```

--------------------------------

### Safe Removal Commands

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Commands for safely uninstalling clients or profiles.

```bash
xmemo uninstall <client> --dry-run
xmemo uninstall <client> --yes
xmemo uninstall --all --dry-run
xmemo uninstall --all --yes --profiles
```

--------------------------------

### Add Existing Token via PowerShell

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Use PowerShell to securely input and add a token.

```powershell
$xmemoToken = Read-Host "XMemo token"
$xmemoToken | xmemo token add --from-stdin --allow-plaintext
Remove-Variable xmemoToken
```

--------------------------------

### Authenticate via stdin

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Adds an authentication token securely without exposing it in command-line arguments.

```text
printf '%s' "$XMEMO_KEY" | node scripts/xmemo-skill.mjs auth add --from-stdin --allow-plaintext
```

```powershell
$env:XMEMO_KEY | node scripts/xmemo-skill.mjs auth add --from-stdin --allow-plaintext
```

--------------------------------

### Add Existing Token via Stdin

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Pipe a token to avoid command history exposure, then verify the status.

```bash
printf '%s\n' 'your-token' | xmemo token add --from-stdin --allow-plaintext
xmemo token status --verify
```

--------------------------------

### Add JSON Client Definition

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Register the client within the JSON_MCP_CLIENT_DEFINITIONS array using the httpClientDefinition helper.

```javascript
export const JSON_MCP_CLIENT_DEFINITIONS = Object.freeze([
  httpClientDefinition('cursor', 'Cursor', 'defaultCursorConfigPath', { urlKey: 'url', authentication: 'env-bearer' }),
  // ... other clients ...
  httpClientDefinition('foobar', 'FooBar IDE', 'defaultFoobarConfigPath', { urlKey: 'url', authentication: 'env-bearer' }),
]);
```

--------------------------------

### Save Information to XMemo

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Store new information using natural language commands.

```text
Remember in XMemo: Always use TypeScript strict mode in this project
```

--------------------------------

### Add a TODO

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Adds a new task item to the TODO list.

```text
node scripts/xmemo-skill.mjs todo-add --content "Add unit tests for ledger expense command"
```

--------------------------------

### Add Extra Configuration Fields

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Injects additional key-value pairs into the server configuration using the extra object.

```javascript
httpClientDefinition('client-id', 'Client Label', 'defaultConfigPath', {
  urlKey: 'url',
  authentication: 'oauth',
  extra: { type: 'http' }  // Adds "type": "http" to server config
})
```

--------------------------------

### Set XMEMO_KEY Environment Variable

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Configures the required authentication environment variable for different shells.

```powershell
$token = xmemo token show --format raw
[Environment]::SetEnvironmentVariable("XMEMO_KEY", $token, "User")
```

```powershell
$env:XMEMO_KEY = xmemo token show --format raw
```

```bash
export XMEMO_KEY=$(xmemo token show --format raw)
```

--------------------------------

### Define TOML Client

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Register a TOML-based client by setting its configuration properties and generation functions.

```javascript
clients.set('your-client', {
  label: 'Your Client',
  defaultConfigPath: deps.defaultYourClientConfigPath,
  buildSnippet: deps.yourClientTomlSnippet,  // Create this function
  writeConfig: deps.appendTomlServerConfig,
  configKind: 'toml'
});
```

--------------------------------

### Perform structured operations

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Executes commands with JSON metadata and boolean flags.

```text
node scripts/xmemo-skill.mjs remember --content "Verified decision" --path "projects/demo/decisions" --metadata '{"source":"review"}'
node scripts/xmemo-skill.mjs search --query "active implementation" --explain true --prefer_working false --compact
```

--------------------------------

### Define a Nested Transport Client

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Registers a client that utilizes the experimentalModelContextProtocolServers configuration section.

```javascript
nestedTransportClientDefinition('client-id', 'Client Label', 'defaultConfigPathFunction')
```

--------------------------------

### Release via Git tag

Source: https://github.com/yonro/memory-os-cli/blob/main/extensions/vscode/PUBLISHING.md

Trigger the CI release workflow by pushing a versioned tag.

```bash
# bump version in extensions/vscode/package.json, commit, then:
git tag vscode-v0.1.0
git push origin vscode-v0.1.0
```

--------------------------------

### Define an HTTP Client

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Registers a client using HTTP transport with specified authentication and URL key options.

```javascript
httpClientDefinition('client-id', 'Client Label', 'defaultConfigPathFunction', {
  urlKey: 'url',              // or 'httpUrl', 'serverUrl'
  authentication: 'env-bearer' // or 'oauth'
})
```

--------------------------------

### Manage formal token handoff

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Commands to check the status of a formal token claim and confirm the handoff process.

```text
node scripts/xmemo-skill.mjs auth claim-status
node scripts/xmemo-skill.mjs auth claim-confirm
```

--------------------------------

### Verify XMemo credentials

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Commands to verify stored credentials against the hosted endpoint.

```text
node scripts/xmemo-skill.mjs auth status --verify
node scripts/xmemo-skill.mjs auth-status --verify
```

--------------------------------

### xmemo CLI Operations

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

A collection of CLI commands for interacting with the xmemo skill, including memory storage, state management, and task tracking.

```APIDOC
## remember
### Description
Stores a decision or piece of information in the memory system.
### Usage
`node scripts/xmemo-skill.mjs remember --content <string> --path <string> [--metadata <json>]`

## recall
### Description
Retrieves information from memory based on a query.
### Usage
`node scripts/xmemo-skill.mjs recall --query <string> [--compact]`

## search
### Description
Performs a search operation with advanced controls.
### Usage
`node scripts/xmemo-skill.mjs search --query <string> [--explain <bool>] [--prefer_working <bool>] [--compact]`

## save-state
### Description
Saves the current handoff state associated with a specific key.
### Usage
`node scripts/xmemo-skill.mjs save-state --key <string> [--ttl_seconds <int>]`

## restore-state
### Description
Restores a previously saved handoff state.
### Usage
`node scripts/xmemo-skill.mjs restore-state --key <string>`

## restart-snapshot
### Description
Captures the active state and context for session continuity.
### Usage
`node scripts/xmemo-skill.mjs restart-snapshot [--session_id <string>] [--timeline_limit <int>] [--ttl_seconds <int>]`

## restart-restore
### Description
Restores a session from a restart snapshot.
### Usage
`node scripts/xmemo-skill.mjs restart-restore [--source_session_id <string>] [--target_session_id <string>]`

## todo-add
### Description
Adds a new item to the TODO list.
### Usage
`node scripts/xmemo-skill.mjs todo-add --content <string>`

## expense-add
### Description
Records a new expense item.
### Usage
`node scripts/xmemo-skill.mjs expense-add --item <string> --amount <number> --currency <string>`

## auth add
### Description
Adds an authentication token to the system.
### Usage
`printf '%s' "$XMEMO_KEY" | node scripts/xmemo-skill.mjs auth add --from-stdin --allow-plaintext`
```

--------------------------------

### Verify XMemo service reachability

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/SKILL.md

Checks if the public service is reachable without requiring credentials.

```text
node scripts/xmemo-skill.mjs doctor --anonymous
```

--------------------------------

### Authenticate XMemo account

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/SKILL.md

Initiates the device-login flow for account-backed memory, requiring explicit acceptance of local plaintext credential storage.

```text
node scripts/xmemo-skill.mjs login --allow-plaintext
```

--------------------------------

### Register temporary fallback account

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Use these commands to register a temporary account when formal registration is declined or for unattended automation. Requires the --allow-plaintext flag.

```text
node scripts/xmemo-skill.mjs register --reason declined --allow-plaintext
node scripts/xmemo-skill.mjs register --reason unattended --allow-plaintext
```

--------------------------------

### Run XMemo doctor diagnostics

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Commands to check service health and credential validity.

```text
node scripts/xmemo-skill.mjs doctor
```

```text
node scripts/xmemo-skill.mjs doctor --anonymous
```

```text
node scripts/xmemo-skill.mjs doctor --base-url https://xmemo.dev
```

```text
node scripts/xmemo-skill.mjs doctor --timeout-ms 60000
```

--------------------------------

### Verify Environment Variables

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Check if the XMEMO_KEY environment variable is set in the current shell.

```powershell
$env:XMEMO_KEY
```

```bash
echo $XMEMO_KEY
```

--------------------------------

### Authenticate for Automation

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

Use the plaintext flag for non-interactive automation environments.

```bash
xmemo login --allow-plaintext
```

--------------------------------

### Common error repair commands

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Commands used to resolve common authentication and configuration errors.

```text
node scripts/xmemo-skill.mjs login --allow-plaintext
```

```text
'{"source":"review"}'
```

```text
true
```

```text
false
```

--------------------------------

### Define a Remote Client

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Registers a client that supports OAuth authentication exclusively.

```javascript
remoteClientDefinition('client-id', 'Client Label', 'defaultConfigPathFunction')
```

--------------------------------

### Export Client Path Function

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Register the new path function in the central clients module.

```javascript
import {
  // ... existing imports ...
  defaultFoobarConfigPath
} from './identity/paths.js';

// ...

export {
  // ... existing exports ...
  defaultFoobarConfigPath
};
```

--------------------------------

### Record an expense

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Logs an expense item with an amount and currency.

```text
node scripts/xmemo-skill.mjs expense-add --item "team lunch" --amount 42.5 --currency USD
```

--------------------------------

### Check XMemo Authentication Status

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Verify the current authentication status of the XMemo CLI.

```bash
xmemo auth status
xmemo token status --verify
```

--------------------------------

### Recall information

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Retrieves information based on a query string.

```text
node scripts/xmemo-skill.mjs recall --query "package manager convention for memory-os-cli" --compact
```

--------------------------------

### Hosted MCP Endpoint

Source: https://github.com/yonro/memory-os-cli/blob/main/README.md

The universal HTTP endpoint for XMemo streamable connections.

```text
https://xmemo.dev/mcp
```

--------------------------------

### Export Path Function

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Import and export the new path function in the central clients module.

```javascript
import {
  // ... existing imports ...
  defaultYourClientConfigPath
} from './identity/paths.js';

// ... 

export {
  // ... existing exports ...
  defaultYourClientConfigPath
};
```

--------------------------------

### Specify Custom JSON Section

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Overrides the default mcpServers configuration section with a custom section name.

```javascript
commandClientDefinition('client-id', 'Client Label', 'defaultConfigPath', {
  section: 'context_servers'  // Use 'context_servers' instead of 'mcpServers'
})
```

--------------------------------

### Set Persistent Environment Variable

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/README.md

Configures the XMEMO_KEY environment variable in PowerShell to persist across sessions.

```powershell
# PowerShell (persistent)
$token = xmemo token show --format raw
[Environment]::SetEnvironmentVariable("XMEMO_KEY", $token, "User")
```

--------------------------------

### Check Authentication Status

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/troubleshooting.md

Verify if credentials are stored without exposing the token value.

```text
node scripts/xmemo-skill.mjs auth status
# equivalent discovery-compatible alias
node scripts/xmemo-skill.mjs auth-status
```

--------------------------------

### Remember a decision

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Stores a decision note at a specific path.

```text
node scripts/xmemo-skill.mjs remember --content "Use pnpm for package management in this repo" --path "projects/memory-os-cli/conventions"
```

--------------------------------

### Search XMemo Memory

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Use natural language to query stored information.

```text
Search XMemo for coding style preferences for this project
```

--------------------------------

### Restore handoff state

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Restores a previously saved state using its key.

```text
node scripts/xmemo-skill.mjs restore-state --key active_task
```

--------------------------------

### Verify XMemo authentication status

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/SKILL.md

Confirms the validity of stored credentials before performing memory operations.

```text
node scripts/xmemo-skill.mjs auth status --verify
```

--------------------------------

### Recall XMemo Decisions

Source: https://github.com/yonro/memory-os-cli/blob/main/plugins/kiro/SETUP.md

Retrieve previously saved decisions or information.

```text
Recall what I saved about API design patterns
```

--------------------------------

### Configure Custom Identity ID

Source: https://github.com/yonro/memory-os-cli/blob/main/ADDING_CLIENTS.md

Allows multiple clients to share the same agent instance identity via the defaultIdentityId property.

```javascript
httpClientDefinition('antigravity-ide', 'Antigravity IDE', 'defaultAntigravityIdeConfigPath', {
  urlKey: 'url',
  authentication: 'oauth',
  defaultIdentityId: 'antigravity'  // Share identity with 'antigravity' client
})
```

--------------------------------

### Save handoff state

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Saves the current state associated with a specific key.

```text
node scripts/xmemo-skill.mjs save-state --key active_task
```

--------------------------------

### Deny pending token bind

Source: https://github.com/yonro/memory-os-cli/blob/main/skills/xmemo/references/operations.md

Rejects a pending bind request to maintain the current isolated temporary credential.

```text
node scripts/xmemo-skill.mjs auth claim-deny
```
Tokens:
Raw