Skip to main content

Node.js Package Integration

Using the published package: @ci-dokumentor/cli​

The CLI is published as a scoped npm package @ci-dokumentor/cli. The package includes all necessary dependencies bundled together, making it a standalone tool that works independently of the monorepo structure.

Package Information​

  • Package Name: @ci-dokumentor/cli
  • Binary Name: ci-dokumentor
  • Registry: npm registry
  • Standalone: Includes all workspace dependencies bundled

One-off usage with npx​

npx @ci-dokumentor/cli --help
npx @ci-dokumentor/cli generate --source action.yml

Install & run with npm (global)​

npm install -g @ci-dokumentor/cli
ci-dokumentor generate --source action.yml

Install & run with pnpm (global)​

pnpm add -g @ci-dokumentor/cli
ci-dokumentor generate --source action.yml

Using Yarn (global)​

yarn global add @ci-dokumentor/cli
ci-dokumentor generate --source action.yml

Running from package.json scripts​

Add a script to your repository's package.json:

{
  "scripts": {
    "doc:generate": "@ci-dokumentor/cli generate --source action.yml"
  },
  "devDependencies": {
    "@ci-dokumentor/cli": "^0.0.1"
  }
}

Then run:

npm run doc:generate
# or
pnpm run doc:generate

Local installation (project-specific)​

You can also install the CLI locally in your project:

npm install --save-dev @ci-dokumentor/cli
# or
pnpm add -D @ci-dokumentor/cli

Then use it via npx or package scripts:

npx @ci-dokumentor/cli generate --source action.yml

For detailed CLI options and platform support, see:

  • CLI Package - Complete command-line interface reference and all available options
  • Introduction - Quick start and other installation methods