bcdocker 1.0.0 → 1.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Oleksandr (Ciellos)
+Copyright (c) 2026 bcdocker contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,165 +1,136 @@
-# bcd — BC Docker MCP Server & CLI
+# bcdocker
 
-An MCP (Model Context Protocol) server and CLI for managing Business Central Docker containers. Lets AI assistants in Cursor, VS Code, or Claude Desktop directly manage your BC dev environments.
-
-## Prerequisites
-
-- **Node.js 18+**
-- **Windows PowerShell 5.1** (BC management cmdlets require it)
-- **Docker Desktop** in Windows containers mode
-- **BCDocker PowerShell module** (the `PartnerScript/` sibling folder)
-
-## Setup
+MCP server and CLI for **Business Central Docker** container management. Run via `npx` -- no install needed.
 
 ```bash
-cd bcd
-npm install
-npm run build
+npx bcdocker list              # list containers
+npx bcdocker create            # create a BC sandbox
+npx bcdocker test bcsandbox    # run AL tests
 ```
 
-## Usage: MCP Server
+## Quick start
+
+### As MCP server (AI assistants)
 
-### Cursor
+Zero-install -- add to your IDE config and your AI can manage BC containers directly:
 
-Add to your Cursor MCP settings (`.cursor/mcp.json` or workspace settings):
+**Cursor** (`.cursor/mcp.json`):
 
 ```json
 {
   "mcpServers": {
     "bcd": {
-      "command": "node",
-      "args": ["C:/myspace/work/Mine/DockerUtils/bcd/dist/server.js"]
+      "command": "npx",
+      "args": ["-y", "bcdocker"]
     }
   }
 }
 ```
 
-### Claude Desktop
-
-Add to `claude_desktop_config.json`:
+**Claude Desktop** (`claude_desktop_config.json`):
 
 ```json
 {
   "mcpServers": {
     "bcd": {
-      "command": "node",
-      "args": ["C:/myspace/work/Mine/DockerUtils/bcd/dist/server.js"]
+      "command": "npx",
+      "args": ["-y", "bcdocker"]
     }
   }
 }
 ```
 
-### VS Code (Copilot)
-
-Add to `.vscode/mcp.json`:
+**VS Code / Copilot** (`.vscode/mcp.json`):
 
 ```json
 {
   "servers": {
     "bcd": {
       "type": "stdio",
-      "command": "node",
-      "args": ["C:/myspace/work/Mine/DockerUtils/bcd/dist/server.js"]
+      "command": "npx",
+      "args": ["-y", "bcdocker"]
     }
   }
 }
 ```
 
-After configuring, your AI assistant can:
+Once configured, ask your AI assistant things like:
 
 - "List my BC containers"
-- "Create a new BC sandbox container with version 26.0"
+- "Create a new BC sandbox with version 26.0"
 - "Show me the apps in bcsandbox"
 - "Run tests in my container"
-- "Compile and publish my AL project to bcsandbox"
-- "Stop the bcsandbox container"
+- "Compile and publish my AL project"
 
-## Usage: CLI
+### As CLI
 
-```bash
-# List containers
-node dist/cli.js list
+**Via npx (no install):**
 
-# Container details
-node dist/cli.js info bcsandbox
+```bash
+npx bcdocker list
+npx bcdocker info bcsandbox
+npx bcdocker create --name bcsandbox --version 26.0 --country w1 --bypass-cdn
+npx bcdocker start bcsandbox
+npx bcdocker stop bcsandbox
+npx bcdocker apps bcsandbox --publisher Microsoft
+npx bcdocker test bcsandbox --codeunit 50100
+```
 
-# Create container
-node dist/cli.js create --name bcsandbox --version 26.0 --country w1 --bypass-cdn
+**Global install** (puts `bcd` on your PATH):
 
-# Start / Stop / Restart
-node dist/cli.js start bcsandbox
-node dist/cli.js stop bcsandbox
-node dist/cli.js restart bcsandbox
+```bash
+npm i -g bcdocker
+bcd list
+bcd create --name mybc --version 26.0
+bcd test mybc
+```
 
-# Remove container
-node dist/cli.js remove bcsandbox
+## Prerequisites
 
-# Open web client
-node dist/cli.js open bcsandbox
+- **Node.js 18+**
+- **Windows PowerShell 5.1** (BC management cmdlets require it)
+- **Docker Desktop** in Windows containers mode
 
-# List apps
-node dist/cli.js apps bcsandbox
-node dist/cli.js apps bcsandbox --publisher Microsoft
+The npm package bundles the PowerShell module in `ps/`. Override with `BCD_MODULE_PATH` if needed.
 
-# Install .app file
-node dist/cli.js install bcsandbox "C:\apps\MyApp.app"
+## CLI commands
 
-# Compile and publish AL project
-node dist/cli.js publish bcsandbox "C:\Projects\MyApp"
+| Command | Description |
+|---|---|
+| `list` / `ls` | List all BC containers with status |
+| `info <container>` | Show version, status, and endpoints |
+| `create` | Create a new BC container (5-30 min) |
+| `remove <container>` | Remove a container |
+| `start <container>` | Start a stopped container |
+| `stop <container>` | Stop a running container |
+| `restart <container>` | Restart a container |
+| `open <container>` | Open BC Web Client in browser |
+| `apps <container>` | List apps (optional `--publisher`) |
+| `install <container> <appFile>` | Install a .app file |
+| `uninstall <container> <app> <publisher>` | Uninstall an app |
+| `publish <container> <folder>` | Compile and publish an AL project |
+| `test [container]` | Run AL tests (optional `--codeunit`, `--function`, `--app`) |
+| `toolkit <container>` | Import test toolkit (`--full` for all) |
+| `license <container> <file>` | Import a license file |
 
-# Run tests
-node dist/cli.js test bcsandbox
-node dist/cli.js test bcsandbox --codeunit 50100
-node dist/cli.js test bcsandbox --app "C:\Projects\MyApp.Test"
+## MCP tools
 
-# Import test toolkit
-node dist/cli.js toolkit bcsandbox
-node dist/cli.js toolkit bcsandbox --full
+The same 15 operations exposed as MCP tools for AI assistants:
 
-# Import license
-node dist/cli.js license bcsandbox "C:\license.bclicense"
-```
+`list-containers` `container-info` `create-container` `remove-container` `start-container` `stop-container` `restart-container` `open-webclient` `list-apps` `install-app` `uninstall-app` `publish-project` `run-tests` `import-test-toolkit` `import-license`
 
-### Global install (optional)
+## Naming
 
-```bash
-npm link
-# Now use 'bcd' directly:
-bcd list
-bcd create --name mybc --version 26.0
-bcd apps mybc
-```
+| Term | What it is |
+|------|------------|
+| **`bcdocker`** | This npm package and GitHub repo. |
+| **`bcd`** | The CLI command after global install (`npm i -g bcdocker`). |
+| **`bcdocker-toolkit`** | The PowerShell + Windows UI repo (module **BCDocker**). Different repo. |
 
-## MCP Tools Reference
+## Related
 
-| Tool | Description |
-|---|---|
-| `list-containers` | List all BC containers with status |
-| `container-info` | Get version, status, and endpoints |
-| `create-container` | Create a new BC container (5-30 min) |
-| `remove-container` | Remove a container |
-| `start-container` | Start a stopped container |
-| `stop-container` | Stop a running container |
-| `restart-container` | Restart a container |
-| `list-apps` | List apps in a container |
-| `install-app` | Install a .app file |
-| `publish-project` | Compile and publish an AL project |
-| `import-test-toolkit` | Import test toolkit |
-| `import-license` | Import a license file |
-| `run-tests` | Run AL tests |
-
-## Architecture
+- **[bcdocker-toolkit](https://github.com/olederkach/bcdocker-toolkit)** -- PowerShell module and Windows UI for Business Central Docker containers
 
-```
-bcd/
-├── src/
-│   ├── server.ts       # MCP server — exposes tools over stdio
-│   ├── cli.ts          # CLI — same operations via command line
-│   └── executor.ts     # PowerShell 5.1 execution layer
-├── dist/               # Compiled JS (after npm run build)
-├── package.json
-├── tsconfig.json
-└── README.md
-```
+## License
 
-The MCP server and CLI both call through `executor.ts`, which spawns `powershell.exe` (5.1, not pwsh 7.x) and imports the `BCDocker.psm1` module from the sibling `PartnerScript/` folder. This ensures all the BcContainerHelper cmdlets work correctly, including on BC 28+.
+MIT

package/dist/cli-main.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli-main.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { runCli } from "./cli.js";
+const isMainModule = process.argv[1] &&
+    resolve(fileURLToPath(import.meta.url)) === resolve(process.argv[1]);
+if (isMainModule) {
+    runCli(process.argv).catch((err) => {
+        console.error("Error:", err.message);
+        process.exit(1);
+    });
+}

package/dist/cli.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env node
-export {};
+import { Command } from "commander";
+/** Builds the CLI (exported for tests). */
+export declare function createCliProgram(): Command;
+export declare function runCli(argv: string[]): Promise<void>;