Unicode CLI

Unicode CLI lets you run local sync sessions against a Unikraft-hosted workspace.

Install

Global install:

npm install -g unikernel-ai-opencode

Or run via npx:

npx unicode-cli --help

Quickstart (Session Connect)

1. Start sync session:

unicode run

2. CLI prompt behavior:

• Choose current directory
• Or enter a custom directory

3. Start sync session from a specific directory directly:

unicode run /absolute/or/relative/path

4. Stop session (graceful close):

• Press Ctrl+C.
• CLI performs final push + pull, archives to R2, cleans remote live workspace, and keeps local files intact.

No API key input is required for normal local usage flow. The CLI auto-creates a workspace on first run when one is not configured.

Useful Commands

unicode run [directory]      # Primary sync command
unicode dev [directory]      # Compatibility alias
unicode open                 # Launch runtime (project/deploy environments)
unicode backend deploy       # Deploy backend (project/deploy environments)
unicode init [name]          # Optional manual workspace creation
unicode login <token>        # Optional manual auth/backend override

macOS Global Install Permission Fix (EACCES)

If npm install -g ... fails with EACCES, switch npm global prefix to your user directory:

mkdir -p "$HOME/.npm-global"
npm config set prefix "$HOME/.npm-global"
echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> "$HOME/.zshrc"
source "$HOME/.zshrc"

Then install again:

npm install -g unicode-cli

Publish to npm

Before publishing, ensure package name is available. If needed, change name in package.json to another unscoped name.

npm login
npm run build
npm run pack:check
npm publish --access public

Notes

• unicode run is intended for end users.
• Deployment commands (unicode open, unicode backend deploy) are intended for environments that have Unikraft tooling and project assets configured.