VectorCI guide

Install VectorCI in a repository

Add the official VectorCI CLI so humans, package scripts, and agents use the same reviewed version.

Requirements

VectorCI supports native macOS and Windows clients. Install Node.js 24, Git, and GitHub CLI before adding the package.

Node.js 24.x
Git with an origin remote pointing to the target GitHub repository
GitHub CLI (gh) for browser-based GitHub authentication
A private, trusted GitHub repository

Recommended: install in the codebase

A project-local development dependency records VectorCI in package.json and the lockfile. That gives users, CI, and agents one reproducible command surface without relying on a machine-wide installation.

Install and start setup

npm install --save-dev --save-exact @orintech/vectorci@0.5.0
npx vectorci auth login
npx vectorci setup .

Add repository commands

Package scripts make the supported entry points obvious to contributors and coding agents.

package.json

{
  "scripts": {
    "vectorci:plan": "vectorci setup .",
    "vectorci:doctor": "vectorci doctor .",
    "vectorci:docs": "vectorci docs"
  }
}

Run the pinned local CLI

npm run vectorci:plan
npm run vectorci:doctor
npm run vectorci:docs

Global and one-off alternatives

A global install is convenient for a workstation. A one-off command is useful for exploration, but a codebase dependency is the recommended shared setup.

Global install

npm install --global @orintech/vectorci@0.5.0
vectorci docs --open

One-off run

npx @orintech/vectorci@0.5.0 docs