Skip to content

deployment.md

Latest commit

 

History

History
212 lines (143 loc) · 3.45 KB

deployment.md

File metadata and controls

212 lines (143 loc) · 3.45 KB
Raw

Deployment Guide

This document describes how to package, copy, install, configure, and verify codemini-cli from a .tgz file.

1. Build The TGZ Package

Run this in the project root on the packaging machine:

npm pack

Expected output:

codemini-cli-0.5.5.tgz

If you want to verify the package contents:

tar -tf codemini-cli-0.5.5.tgz

2. Copy To The Target Machine

Copy the generated .tgz file to the Win10 machine by one of these methods:

  • company internal file share
  • USB drive
  • secure artifact repository
  • SCP or similar internal transfer tool

Recommended target path:

C:\temp\codemini-cli-0.5.5.tgz

3. Environment Requirements

Target machine requirements:

  • Windows 10
  • Node.js 22 or newer
  • npm available
  • PowerShell available

Check:

node -v
npm -v

4. Install From TGZ

Global install:

npm install -g C:\temp\codemini-cli-0.5.5.tgz

If global install is blocked by company policy, install in a working directory instead:

mkdir C:\temp\coder-test
cd C:\temp\coder-test
npm install C:\temp\codemini-cli-0.5.5.tgz

5. Confirm Installation

If installed globally:

codemini --help

If installed locally without global bin exposure:

npx codemini --help

Or:

node .\node_modules\codemini-cli\bin\coder.js --help

6. Initial Configuration

Set your internal gateway, key, model, and shell:

codemini config set gateway.base_url https://your-internal-gateway/v1
codemini config set gateway.api_key your_token
codemini config set model.name your_model_id
codemini config set model.max_context_tokens 32768
codemini config set shell.default powershell

Optional but recommended:

codemini config set gateway.timeout_ms 180000
codemini config set gateway.max_retries 2

Check current config:

codemini config list

7. Smoke Test

Run the built-in environment check:

codemini doctor

Then launch the TUI:

codemini

Inside the TUI, test these:

/config list
/history list
/spec 写一个Win10内部CLI权限规范
/plan from-spec
帮我创建一个 hello.js
读取 hello.js

8. Installed Data Locations

Project-scoped data:

.coder\

Global user/tool data on Win10:

%APPDATA%\codemini-cli\

Typical contents:

  • config.json
  • sessions\
  • skills\
  • project skills are stored per workspace under .codemini\skills\
  • input-history.json

9. Skills

List installed skills:

codemini skill list

Install a local skill into the current project:

codemini skill install C:\path\to\skill-folder

Install a local skill globally:

codemini skill install --scope=global C:\path\to\skill-folder

Rebuild the global registry:

codemini skill reindex

10. Uninstall

Global uninstall:

npm uninstall -g codemini-cli

Local uninstall inside a test directory:

npm uninstall codemini-cli

11. Known Limitation

This .tgz package is suitable for package distribution, but it is not a fully self-contained offline dependency bundle.

If the target machine is completely air-gapped and does not already have the required npm dependencies available, prepare one of these instead:

  • a tested node_modules bundle
  • a company internal npm mirror
  • a dedicated offline installer bundle