@arpixel/api-contract 0.1.0 → 0.1.2

package/README.md

@@ -89,13 +89,14 @@ Actual frontend impact
 Generate frontend-ready TypeScript from an OpenAPI specification:
 
 ```bash
-npx api-contract generate openapi.yaml
+npx @arpixel/api-contract generate openapi.yaml
 ```
 
 The default output is:
 
 ```text
 api-contract/generated/
+
 ├── types.ts
 └── api.ts
 ```
@@ -105,13 +106,14 @@ The output directory is resolved relative to the current working directory.
 ### Custom output
 
 ```bash
-npx api-contract generate openapi.yaml --output src/api/generated
+npx @arpixel/api-contract generate openapi.yaml --output src/api/generated
 ```
 
 Produces:
 
 ```text
 src/api/generated/
+
 ├── types.ts
 └── api.ts
 ```
@@ -145,7 +147,7 @@ export interface ApiMethods {
 Compare two OpenAPI specifications:
 
 ```bash
-npx api-contract diff old.yaml new.yaml
+npx @arpixel/api-contract diff old.yaml new.yaml
 ```
 
 The comparison identifies structural contract changes including:
@@ -169,7 +171,7 @@ Changes are classified as **breaking** or **non-breaking** according to the supp
 ### Human-readable output
 
 ```bash
-npx api-contract diff examples/old.yaml examples/new.yaml
+npx @arpixel/api-contract diff examples/old.yaml examples/new.yaml
 ```
 
 Example:
@@ -183,19 +185,24 @@ Modified:  1
 Breaking:  2
 
 BREAKING
+
   DELETE /devices/{id} was removed.
+
   Device.status changed from optional to required.
 
 NON-BREAKING
+
   POST /devices was added.
+
   Device.serialNumber was added.
+
   DeviceStatus enum value "suspended" was added.
 ```
 
 ### Machine-readable output
 
 ```bash
-npx api-contract diff examples/old.yaml examples/new.yaml --format json
+npx @arpixel/api-contract diff examples/old.yaml examples/new.yaml --format json
 ```
 
 The JSON output provides a stable V1 structure:
@@ -233,17 +240,17 @@ The AI-assisted impact workflow takes the deterministic diff and analyzes the fr
 
 ```text
 api-contract diff
-        ↓
+       ↓
 Contract changes
-        ↓
+       ↓
 AI coding agent
-        ↓
+       ↓
 Frontend repository
-        ↓
+       ↓
 Search + dependency tracing
-        ↓
+       ↓
 Actual consumers
-        ↓
+       ↓
 Impact report
 ```
 
@@ -308,27 +315,29 @@ The three capabilities can be used independently or together.
 
 ```text
                          OpenAPI
-                            │
-          ┌─────────────────┼─────────────────┐
-          │                 │                 │
-          ▼                 ▼                 ▼
-       GENERATE           COMPARE          ANALYZE
-          │                 │                 │
-          ▼                 ▼                 │
-   TypeScript client    What changed?        │
-   types.ts + api.ts    Breaking?            │
-                            │                 │
-                            ▼                 │
-                     Structured diff ─────────┘
+
+                           │
+
+          ┌────────────────┼────────────────┐
+          │                │                │
+          ▼                ▼                ▼
+       GENERATE          COMPARE          ANALYZE
+          │                │                │
+          ▼                ▼                │
+   TypeScript client    What changed?       │
+   types.ts + api.ts    Breaking?           │
+                              │              │
+                              ▼              │
+                       Structured diff ──────┘
                                       │
                                       ▼
-                                AI agent
+                                  AI agent
                                       │
                                       ▼
-                            Frontend repository
+                              Frontend repository
                                       │
                                       ▼
-                               Impact report
+                                Impact report
 ```
 
 A typical API evolution workflow becomes:
@@ -357,17 +366,17 @@ The architecture is:
 
 ```text
 api-contract
-    │
+
     ├── generate
     ├── diff
     │
     └── deterministic contract data
                   │
                   ▼
-             AI agent
+              AI agent
                   │
                   ▼
-        repository-aware analysis
+         repository-aware analysis
 ```
 
 This means:
@@ -387,6 +396,7 @@ The repository includes integration artifacts:
 
 ```text
 integrations/vscode/
+
 ├── api-contract-generate.prompt.md
 ├── api-contract-generate.agent.md
 ├── api-contract-impact.prompt.md
@@ -396,20 +406,34 @@ integrations/vscode/
 Install these integrations for your user account with:
 
 ```bash
-npx api-contract init --host vscode
+npx @arpixel/api-contract init --host vscode
 ```
 
-This installs the prompts under `~/.api-contract/prompts/` and the agents under
-`~/.copilot/agents/`. The command does not modify VS Code settings.
+The `init` command copies the bundled integration files into your user account:
+
+```text
+~/.api-contract/prompts/
+
+├── api-contract-generate.prompt.md
+└── api-contract-impact.prompt.md
+
+~/.copilot/agents/
+
+├── api-contract-generate.agent.md
+└── api-contract-impact.agent.md
+```
+
+The prompts are installed under `~/.api-contract/prompts/` and the agents under `~/.copilot/agents/`.
+
+The command creates the required directories and updates the managed files when run again. It **does not modify VS Code settings automatically**.
 
 ### Prompt usage
 
 Choose one of these options for the prompts:
 
-1. **Repository-local** — Copy `~/.api-contract/prompts/` into
-   `<repository>/.github/prompts/` to make the prompts available to that repository.
-2. **Global** — Add `~/.api-contract/prompts` as a directory in VS Code's
-   `chat.promptFilesLocations` setting. Add the directory, not individual file paths.
+1. **Repository-local** — Copy `~/.api-contract/prompts/` into `<repository>/.github/prompts/` to make the prompts available to that repository.
+
+2. **Global** — Add `~/.api-contract/prompts` as a directory in VS Code's `chat.promptFilesLocations` setting. Add the directory, not individual file paths.
 
 The agents installed under `~/.copilot/agents/` can be selected from the VS Code Chat agent experience.
 
@@ -468,7 +492,7 @@ The analysis is read-only by default and does not modify source code unless expl
 ```text
                          OpenAPI
                             │
-                     OpenAPI parser
+                      OpenAPI parser
                             │
           ┌─────────────────┼─────────────────┐
           │                 │                 │
@@ -476,20 +500,20 @@ The analysis is read-only by default and does not modify source code unless expl
        GENERATE           COMPARE          ANALYZE*
           │                 │                 │
           ▼                 ▼                 │
-    TypeScript         Structured diff        │
-      client                 │               │
-          │                  │               │
-          │                  ▼               │
-          │             AI coding agent ◄────┘
-          │                  │
-          │                  ▼
-          │          Frontend repository
-          │                  │
-          │                  ▼
-          │            Impact analysis
+     TypeScript         Structured diff       │
+       client                 │               │
+          │                   │               │
+          │                   ▼               │
+          │              AI coding agent ◄────┘
+          │                   │
+          │                   ▼
+          │           Frontend repository
+          │                   │
+          │                   ▼
+          │             Impact analysis
           │
           ▼
-   types.ts + api.ts
+     types.ts + api.ts
 
 * Analyze is an AI-assisted workflow built on top of
   the deterministic CLI output.
@@ -528,25 +552,43 @@ Impact analysis should prefer concrete repository evidence over assumptions base
 No global installation is required:
 
 ```bash
-npx api-contract --help
+npx @arpixel/api-contract --help
 ```
 
 Generate:
 
 ```bash
-npx api-contract generate openapi.yaml
+npx @arpixel/api-contract generate openapi.yaml
 ```
 
 Compare:
 
 ```bash
-npx api-contract diff old.yaml new.yaml
+npx @arpixel/api-contract diff old.yaml new.yaml
 ```
 
 Install the optional VS Code/Copilot integration:
 
 ```bash
-npx api-contract init --host vscode
+npx @arpixel/api-contract init --host vscode
+```
+
+## Install as a project dependency
+
+Install the CLI in your project:
+
+```bash
+npm install -D @arpixel/api-contract
+```
+
+Then use the `api-contract` binary:
+
+```bash
+npx api-contract generate openapi.yaml
+```
+
+```bash
+npx api-contract diff old.yaml new.yaml
 ```
 
 ## Requirements
@@ -594,6 +636,7 @@ npm run dev -- diff examples/old.yaml examples/new.yaml
 
 ```text
 api-contract/
+
 ├── src/
 │   ├── cli.ts
 │   ├── commands/
@@ -663,7 +706,7 @@ api-contract/
 * mock generation
 * LLM/API-key management inside the CLI
 * direct repository modification by the CLI
-* host-specific agent installation
+* host-specific agent installation beyond the currently supported VS Code/Copilot integration
 
 The goal of V1 is to provide a small, deterministic, composable foundation for working with evolving API contracts and connecting contract changes to frontend code.
 
@@ -687,7 +730,6 @@ Potential future capabilities include:
 * additional breaking-change rules
 * improved API client generation
 * additional AI-agent host integrations
-* repository initialization/install commands
 * broader frontend framework support
 
 The roadmap is intentionally exploratory. The current focus is keeping the three core workflows — **Generate, Compare, Analyze** — deterministic, composable, and useful.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arpixel/api-contract",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Generate API clients. Compare contracts. Analyze frontend impact.",
   "type": "module",
   "bin": {