add pull request command

Author: alerizzo

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18, 20, 22]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Type check
+        run: npx tsc --noEmit
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm test

.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm test
+
+      - name: Publish
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -2,12 +2,26 @@
 
 A command-line tool to interact with [Codacy Cloud](https://app.codacy.com) directly from your terminal. Built with Node.js and TypeScript.
 
-## Setup
+## Installation
+
+### From npm
+
+```bash
+npm install -g codacy-cloud-cli
+```
+
+### From source
 
 ```bash
+git clone https://github.com/alerizzo/codacy-cloud-cli.git
+cd codacy-cloud-cli
 npm install
+npm run build
+npm link
 ```
 
+## Authentication
+
 Set your Codacy API token as an environment variable:
 
 ```bash
@@ -19,12 +33,7 @@ You can get a token from **Codacy > My Account > Access Management > Account API
 ## Usage
 
 ```bash
-# Run in development mode
-npx ts-node src/index.ts <command>
-
-# Or build and run
-npm run build
-npm start -- <command>
+codacy-cloud-cli <command> [options]
 ```
 
 ### Global Options
@@ -106,19 +115,24 @@ codacy-cloud-cli pull-request gh my-org my-repo 42 --output json
 Displays:
 - **About** -- PR title, status, author, branches, head commit
 - **Analysis** -- up-to-standards status, issues, coverage, complexity, duplication with gate pass/fail details
-- **New Issues** -- issues introduced by the PR, sorted by severity, with file path, line content, and detection tool
-- **New Potential Issues** -- potential issues that may need review
+- **Issues** -- issues introduced by the PR, sorted by severity, with file path and line content
 - **Files** -- changed files with metric deltas (issues, coverage, complexity, duplication)
 
 ## Development
 
 ```bash
+# Run in development mode
+npx ts-node src/index.ts <command>
+
 # Run tests
 npm test
 
 # Type-check without emitting
 npx tsc --noEmit
 
+# Build for production
+npm run build
+
 # Update the auto-generated API client
 npm run update-api
 ```
@@ -129,10 +143,22 @@ npm run update-api
 src/
   index.ts          # CLI entry point (Commander.js)
   commands/         # One file per command
-  utils/            # Shared utilities (auth, error handling, output formatting)
+  utils/            # Shared utilities (auth, error handling, output, formatting)
   api/client/       # Auto-generated API client (do not edit)
 ```
 
+### CI/CD
+
+- **CI**: Runs on every push to `main` and on PRs. Builds and tests across Node.js 18, 20, and 22.
+- **Publish**: Triggered on GitHub release creation. Builds, tests, and publishes to npm with provenance.
+
+To publish a new version:
+1. Update the version in `package.json`
+2. Create a GitHub release with a tag matching the version (e.g. `v1.1.0`)
+3. The publish workflow will automatically build and push to npm
+
+**Prerequisite**: Add an `NPM_TOKEN` secret to your GitHub repository settings.
+
 ## License
 
 ISC

TODO.md

@@ -154,10 +154,11 @@ For the Issues List in particular, showing them in a table will not work. So fol
 
 ## Deployment & CI
 
-- [ ] Make the project ready to deploy to npm and be executed as a CLI tool by running `npm install -g`
-- [ ] Add CI pipeline for build + test (GitHub Actions)
-- [ ] Add CI pipeline for deploy to npm (GitHub Actions)
-- [ ] Add CLI help examples to each command
+- [x] 2026-02-18 Make the project ready to deploy to npm and be executed as a CLI tool by running `npm install -g`
+- [x] 2026-02-18 Make the project ready to distribute later as a separate brew formula for macOS/Linux/Windows
+- [x] 2026-02-18 Add CI pipeline for build + test (GitHub Actions)
+- [x] 2026-02-18 Add CI pipeline for deploy to npm (GitHub Actions)
+- [x] 2026-02-18 Add CLI help examples to each command
 
 ---
 
@@ -170,4 +171,7 @@ For the Issues List in particular, showing them in a table will not work. So fol
 - 2026-02-17: `src/commands/CLAUDE.md` created with design decisions
 - 2026-02-18: `repository` command implemented with tests (5 tests) — dashboard with about, setup, metrics, PRs, and issues overview
 - 2026-02-18: Extracted shared formatting helpers to `utils/formatting.ts` (reused by repository + pull-request)
-- 2026-02-18: `pull-request` command implemented with tests (9 tests) — about, analysis with gate reasons, issues cards, files list
+- 2026-02-18: `pull-request` command implemented with tests (11 tests) — about, analysis with gate reasons, issues cards, files list
+- 2026-02-18: npm package ready — bin, files, prepublishOnly, tsconfig.build.json, engines
+- 2026-02-18: CI pipelines — build+test on push/PR (Node 18/20/22), publish to npm on release
+- 2026-02-18: CLI help examples added to all commands

package.json

@@ -1,20 +1,35 @@
 {
   "name": "codacy-cloud-cli",
   "version": "1.0.0",
-  "main": "index.js",
+  "description": "A command-line tool to interact with Codacy Cloud from your terminal",
+  "main": "dist/index.js",
+  "bin": {
+    "codacy": "dist/index.js"
+  },
+  "files": [
+    "dist/"
+  ],
   "scripts": {
     "test": "vitest run",
+    "build": "tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "start": "npx ts-node src/index.ts",
+    "start:dist": "node dist/index.js",
     "fetch-api": "curl https://artifacts.codacy.com/api/codacy-api/50.7.17/apiv3-bundled.yaml -o ./api-v3/api-swagger.yaml --create-dirs",
     "generate-api": "rm -rf ./src/api/client && openapi --input ./api-v3/api-swagger.yaml --output ./src/api/client --useUnionTypes --indent 2 --client fetch",
-    "update-api": "npm run fetch-api && npm run generate-api",
-    "start": "npx ts-node src/index.ts",
-    "build": "npx tsc",
-    "start:dist": "node dist/index.js"
+    "update-api": "npm run fetch-api && npm run generate-api"
   },
-  "keywords": [],
+  "keywords": [
+    "codacy",
+    "cli",
+    "code-quality",
+    "static-analysis"
+  ],
   "author": "",
   "license": "ISC",
-  "description": "",
+  "engines": {
+    "node": ">=18"
+  },
   "dependencies": {
     "ansis": "4.0.0",
     "cli-table3": "^0.6.3",

src/commands/info.ts

@@ -16,6 +16,13 @@ export function registerInfoCommand(program: Command) {
   program
     .command("info")
     .description("Show authenticated user information and organizations")
+    .addHelpText(
+      "after",
+      `
+Examples:
+  $ codacy-cloud-cli info
+  $ codacy-cloud-cli info --output json`,
+    )
     .action(async function (this: Command) {
       try {
         checkApiToken();

src/commands/pull-request.ts

@@ -397,6 +397,13 @@ export function registerPullRequestCommand(program: Command) {
     .argument("<organization>", "organization name")
     .argument("<repository>", "repository name")
     .argument("<prNumber>", "pull request number")
+    .addHelpText(
+      "after",
+      `
+Examples:
+  $ codacy-cloud-cli pull-request gh my-org my-repo 42
+  $ codacy-cloud-cli pull-request gh my-org my-repo 42 --output json`,
+    )
     .action(async function (
       this: Command,
       provider: string,

src/commands/repositories.ts

@@ -52,6 +52,14 @@ export function registerRepositoriesCommand(program: Command) {
     .argument("<provider>", "git provider (gh, gl, or bb)")
     .argument("<organization>", "organization name")
     .option("-s, --search <query>", "filter repositories by name")
+    .addHelpText(
+      "after",
+      `
+Examples:
+  $ codacy-cloud-cli repositories gh my-org
+  $ codacy-cloud-cli repositories gh my-org --search my-repo
+  $ codacy-cloud-cli repositories gl my-org --output json`,
+    )
     .action(async function (
       this: Command,
       provider: string,

src/commands/repository.ts

@@ -200,6 +200,13 @@ export function registerRepositoryCommand(program: Command) {
     .argument("<provider>", "git provider (gh, gl, or bb)")
     .argument("<organization>", "organization name")
     .argument("<repository>", "repository name")
+    .addHelpText(
+      "after",
+      `
+Examples:
+  $ codacy-cloud-cli repository gh my-org my-repo
+  $ codacy-cloud-cli repository gh my-org my-repo --output json`,
+    )
     .action(async function (
       this: Command,
       provider: string,

tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts",
+    "vitest.config.ts"
+  ]
+}