Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Latest commit

History

History
275 lines (207 loc) · 7.55 KB

File metadata and controls

275 lines (207 loc) · 7.55 KB

Setup Guide

Prerequisites

  • Rust 1.75+ (with cargo)
  • A configured upstream provider — either a Command Code account (cmdcode auth) or entries in ~/.cmdcode/providers.json (cmdcode connect add). No external CLI is required; the model catalog is bundled.

Quick start

# Clone the repo
git clone https://github.com/Lythaeon/cmdcode.git
cd cmdcode
# Build and run
cargo run --release
# Or build first, then run
cargo build --release
./target/release/cmdcode

The proxy starts on http://127.0.0.1:18080.

Verify it works

# Health check
curl http://127.0.0.1:18080/health
# List models
curl http://127.0.0.1:18080/v1/models
# Send a completion
curl http://127.0.0.1:18080/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{ "model": "xiaomi/mimo-v2.5", "messages": [{"role": "user", "content": "Say hello"}], "max_tokens": 100 }'

Configuration

Environment variables:

VariableDefaultDescription
COMMAND_CODE_PROXY_PORT18080Listen port
COMMAND_CODE_PROXY_HOST127.0.0.1Bind address
COMMAND_CODE_API_BASEhttps://api.commandcode.aiUpstream API
COMMAND_CODE_PROXY_TIMEOUT600Upstream timeout (seconds)
COMMAND_CODE_PROXY_RETRIES2Retry count for 502/503/504
COMMAND_CODE_PROXY_CORS(unset)CORS origin header
COMMAND_CODE_PROXY_DEFAULTxiaomi/mimo-v2.5Default model
COMMAND_CODE_PROXY_MODELS(unset)Comma-separated model allowlist
COMMAND_CODE_PROXY_MAX_REQS0Max concurrent requests (0=unlimited)
COMMAND_CODE_PROXY_LOG_FILE(unset)Write logs to this file with size-based rotation
COMMAND_CODE_PROXY_LOG_MAX_BYTES52428800Rotate the log after this many bytes (50MB)
COMMAND_CODE_PROXY_LOG_KEEP5Keep this many rotated log backups
COMMAND_CODE_PROXY_INCOMING_TOKEN(unset)Require Authorization: Bearer <token> on API routes
COMMAND_CODE_PROXY_TLS_CERT(unset)Path to a TLS certificate (enables HTTPS; needs KEY too)
COMMAND_CODE_PROXY_TLS_KEY(unset)Path to the matching TLS private key
COMMAND_CODE_LOCAL(unset)Set 1 to use localhost:9090

/metrics and /health are always served unauthenticated for monitors and scrapers. When COMMAND_CODE_PROXY_INCOMING_TOKEN is set, every other route (chat completions, models) requires that token as a bearer header.

Supervision, log rotation, and soak

The scripts/ directory ships three helpers:

Supervision and log rotation

systemd is the preferred supervision mechanism. A user unit ships at systemd/command-code-proxy.service with crash-restart (Restart=on-failure), a stop timeout (TimeoutStopSec=10) so restarts do not block on the proxy's graceful drain, and a restart-loop guard. Install it with:

cp systemd/command-code-proxy.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now command-code-proxy
systemctl --user status command-code-proxy # or journalctl --user -u command-code-proxy

The unit sets COMMAND_CODE_PROXY_LOG_FILE so the proxy writes its own size-rotated log regardless of journald state.

scripts/ also ships:

  • scripts/supervise.sh — a fallback for machines without working systemd user services. Restarts the proxy on crash with exponential backoff (1s to 30s cap). A clean exit (0) stops it; SIGTERM/SIGINT forward to the child.
  • scripts/install-supervisor.sh — installs a @reboot cron entry for the supervisor and starts it now.
  • scripts/soak.sh — long-duration memory/health soak. Every SOAK_SAMPLE_SECS (default 300) it checks /health, issues one streaming chat request, and samples the proxy's RSS, failing if RSS grows more than SOAK_RSS_GROWTH_MB (default 200MB) above baseline or a request fails. Configure with SOAK_HOURS (default 24).
SOAK_HOURS=8 scripts/soak.sh # run an 8-hour soak

For TLS, set COMMAND_CODE_PROXY_TLS_CERT and COMMAND_CODE_PROXY_TLS_KEY to a PEM certificate and key pair. Both must be set together; the proxy then serves HTTPS on the configured listen address.

Run with makefile.toml

# Install cargo-make
cargo install cargo-make
# Available tasks
cargo make build # Build debug
cargo make build-release # Build release
cargo make test# Run all tests
cargo make clippy # Lint with deny-level warnings
cargo make fmt # Format code
cargo make ci # fmt-check + clippy + test

Run as systemd service (Linux)

This sets up the proxy to start automatically on boot and restart on failure.

Step 1: Build the release binary

cd /path/to/cmdcode
cargo build --release

Step 2: Install the binary

# Create ~/.local/bin if it doesn't exist
mkdir -p ~/.local/bin
# Copy the binary
cp target/release/cmdcode ~/.local/bin/
# Make sure ~/.local/bin is in your PATH# Add to ~/.bashrc or ~/.zshrc if not already:# export PATH="$HOME/.local/bin:$PATH"# Verify it works~/.local/bin/cmdcode --help

Step 3: Install the systemd service

# Create the systemd user directory
mkdir -p ~/.config/systemd/user
# Copy the service file
cp systemd/command-code-proxy.service ~/.config/systemd/user/
# Edit the service file to set your username# Replace YOUR_USERNAME with your actual username:
sed -i "s/YOUR_USERNAME/$(whoami)/"~/.config/systemd/user/command-code-proxy.service

Step 4: Enable and start the service

# Reload systemd to pick up the new service
systemctl --user daemon-reload
# Enable the service (starts on boot)
systemctl --user enable command-code-proxy
# Start the service now
systemctl --user start command-code-proxy
# Verify it's running
systemctl --user status command-code-proxy

Step 5: Check logs

# Follow the logs
journalctl --user -u command-code-proxy -f
# Or check recent logs
journalctl --user -u command-code-proxy --since "1 hour ago"

Step 6: Manage the service

# Stop the service
systemctl --user stop command-code-proxy
# Restart after config changes
systemctl --user restart command-code-proxy
# Disable from starting on boot
systemctl --user disable command-code-proxy
# Check if it's running
systemctl --user is-active command-code-proxy

Override environment variables

To change the proxy's configuration without editing the service file:

# Create an override directory
mkdir -p ~/.config/systemd/user/command-code-proxy.service.d
# Create an override file
cat >~/.config/systemd/user/command-code-proxy.service.d/override.conf <<EOF[Service]Environment=COMMAND_CODE_PROXY_PORT=18081Environment=COMMAND_CODE_API_BASE=https://staging.api.commandcode.aiEnvironment=RUST_LOG=debugEOF# Reload and restart
systemctl --user daemon-reload
systemctl --user restart command-code-proxy

Run with Docker

# Build the image
docker build -t cmdcode .# Run
docker run -d \
--name cmdcode \
-p 18080:18080 \
-v ~/.commandcode:/root/.commandcode:ro \
-e COMMAND_CODE_PROXY_HOST=0.0.0.0 \
cmdcode

Run behind nginx (production)

upstream cmdcode_backend {server127.0.0.1:18080;}server{listen443ssl;server_name proxy.example.com;location /v1/ {proxy_passhttp://cmdcode_backend;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_buffering off;proxy_cache off;proxy_read_timeout600s;}}

Architecture

See architecture.md for wire format translation details.