@connxio/cli 0.1.2-beta.2 → 0.1.4

package/README.md

@@ -0,0 +1,274 @@
+# Connxio CLI
+
+Connxio CLI provides the `connxio` command and an MCP server for Connxio management APIs.
+
+The current implementation focuses on MCP usage through:
+
+```bash
+connxio mcp serve
+```
+
+## Prerequisites
+
+- Node.js 24 or newer
+- Connxio OAuth client credentials
+- A Connxio subscription-scoped API key for each subscription context you want to use
+
+## Install
+
+Install the CLI globally from npm:
+
+```bash
+npm i -g @connxio/cli
+```
+
+Verify installation:
+
+```bash
+connxio --help
+```
+
+## Configure OAuth
+
+```bash
+connxio auth configure
+```
+
+You will be prompted for:
+
+- OAuth client id
+- OAuth scope, defaulting to `api://connxio/.default`
+- OAuth client secret
+
+The OAuth token URL is always `https://api.connxio.com/oauth/token`.
+
+Check status:
+
+```bash
+connxio auth status
+```
+
+Clear OAuth configuration:
+
+```bash
+connxio auth clear
+```
+
+You can also configure OAuth with environment variables:
+
+```bash
+CONNXIO_OAUTH_CLIENT_ID="<client-id>"
+CONNXIO_OAUTH_CLIENT_SECRET="<client-secret>"
+CONNXIO_OAUTH_TOKEN_URL="https://api.connxio.com/oauth/token"
+CONNXIO_OAUTH_SCOPE="api://connxio/.default"
+```
+
+`CONNXIO_OAUTH_TOKEN_URL` and `CONNXIO_OAUTH_SCOPE` are optional overrides.
+
+Do not commit OAuth client secrets or put them in MCP client config unless you explicitly accept that local setup tradeoff.
+
+## Configure Contexts
+
+A context represents one Connxio subscription. Connxio API keys are subscription-scoped, so add one context for each subscription you want to use.
+
+```bash
+connxio context add
+```
+
+The CLI calls `/v2/subscriptions/current` with the provided API key and stores the subscription/company metadata locally. API keys are stored through the credential abstraction, not in `config.json`.
+
+List contexts:
+
+```bash
+connxio context list
+```
+
+Set a default context:
+
+```bash
+connxio context default <context-id>
+```
+
+Remove a context:
+
+```bash
+connxio context remove <context-id>
+```
+
+## Register With VS Code
+
+VS Code 1.99+ supports MCP servers natively via GitHub Copilot agent mode.
+
+**Option 1 — user settings (all projects)**
+
+Open `settings.json` (`Cmd+Shift+P` → _Preferences: Open User Settings (JSON)_) and add:
+
+```json
+{
+  "mcp": {
+    "servers": {
+      "connxio": {
+        "type": "stdio",
+        "command": "connxio",
+        "args": ["mcp", "serve"]
+      }
+    }
+  }
+}
+```
+
+**Option 2 — workspace settings (this project only)**
+
+Create `.vscode/mcp.json` in your project root:
+
+```json
+{
+  "servers": {
+    "connxio": {
+      "type": "stdio",
+      "command": "connxio",
+      "args": ["mcp", "serve"]
+    }
+  }
+}
+```
+
+After saving, open a Copilot chat in agent mode (`@workspace` or the **Agent** dropdown) and the Connxio tools will be available.
+
+If you need to pass environment variables (e.g. for OAuth or a custom API base URL), add an `env` block:
+
+```json
+{
+  "servers": {
+    "connxio": {
+      "type": "stdio",
+      "command": "connxio",
+      "args": ["mcp", "serve"],
+      "env": {
+        "CONNXIO_OAUTH_CLIENT_ID": "<client-id>",
+        "CONNXIO_OAUTH_CLIENT_SECRET": "<client-secret>"
+      }
+    }
+  }
+}
+```
+
+Do not commit files containing OAuth client secrets to source control.
+
+## Register With Claude Code
+
+Register the installed MCP server:
+
+```bash
+claude mcp add --scope user --transport stdio connxio -- connxio mcp serve
+```
+
+Verify registration:
+
+```bash
+claude mcp list
+```
+
+If you need to replace an existing registration:
+
+```bash
+claude mcp remove connxio
+claude mcp add --scope user --transport stdio connxio -- connxio mcp serve
+```
+
+## API Base URL
+
+The default API base URL is:
+
+```text
+https://api.connxio.com
+```
+
+Override it per context:
+
+```bash
+connxio context add --base-url http://localhost:5119/api
+```
+
+Or with an environment variable:
+
+```bash
+CONNXIO_API_BASE_URL="http://localhost:5119/api"
+```
+
+For localhost development with self-signed HTTPS certificates, the CLI automatically allows insecure TLS for localhost URLs. For other local development endpoints, use:
+
+```bash
+CONNXIO_INSECURE_TLS=true
+```
+
+Do not use insecure TLS settings in production.
+
+## Run Diagnostics
+
+```bash
+connxio mcp doctor
+```
+
+For HTTP troubleshooting, enable redacted request diagnostics:
+
+```bash
+CONNXIO_DEBUG_HTTP=true connxio mcp doctor
+```
+
+## MCP Tools
+
+The MCP server exposes non-message Connxio v2 management operations.
+
+Context and subscription tools:
+
+- `list_contexts`
+- `get_current_context`
+- `list_subscriptions`
+- `get_current_subscription`
+
+Integration tools:
+
+- `list_integrations`
+- `get_integration`
+- `create_integration`
+- `create_integration_no_validation`
+- `update_integration`
+- `delete_integration`
+
+Code component tools:
+
+- `list_code_components`
+- `get_code_component`
+- `get_code_component_versions`
+- `create_code_component`
+- `deprecate_code_component`
+- `rename_code_component`
+- `delete_code_component`
+
+Environment variable tools:
+
+- `list_environment_variables`
+- `get_environment_variable`
+- `create_environment_variable`
+- `delete_environment_variable`
+
+Security configuration tools:
+
+- `list_security_configs`
+- `get_security_config`
+- `create_security_config`
+- `delete_security_config`
+
+Write tools require `contextId`. Destructive tools require `contextId` and `confirm: true`.
+
+`/messages` operations are intentionally not exposed yet.
+
+## Local Config Files
+
+Non-secret config is stored in:
+
+- macOS/Linux: `${XDG_CONFIG_HOME:-~/.config}/connxio/config.json`
+- Windows: `%APPDATA%\connxio\config.json`
+
+Secrets are stored through the CLI credential abstraction. The current implementation uses a local credential store at the same config root so it can later move to OS keychain storage without changing context consumers.

package/dist/index.mjs

@@ -11222,7 +11222,7 @@ function updateNotifier(options) {
 //#endregion
 //#region packages/cli/package.json
 var name = "@connxio/cli";
-var version$1 = "0.1.2-beta.2";
+var version$1 = "0.1.4";
 var package_default = {
 	name,
 	version: version$1,
@@ -11246,6 +11246,10 @@ var package_default = {
 	types: "./dist/index.d.mts",
 	exports: { ".": "./dist/index.mjs" },
 	publishConfig: { "access": "public" },
+	scripts: {
+		"prepack": "cp ../../README.md ./README.md",
+		"postpack": "rm -f ./README.md"
+	},
 	dependencies: {
 		"@modelcontextprotocol/sdk": "^1.29.0",
 		"commander": "^14.0.3",
@@ -32664,7 +32668,7 @@ async function updateComponentInIntegration(client, input) {
 	if (!isRecord(integration)) throw new Error(`Integration ${integrationId} was not found.`);
 	const existingComponent = await findCodeComponentByName(client, componentName);
 	const nextIntegration = JSON.parse(JSON.stringify(integration));
-	if (!replaceComponentVersion(nextIntegration, [existingComponent?.id, componentName].filter((value) => Boolean(value)), oldVersion, newVersion, { newSasUri: existingComponent?.sasUri ?? void 0 })) return {
+	if (!replaceComponentVersion(nextIntegration, [existingComponent?.id, componentName].filter((value) => Boolean(value)), oldVersion, newVersion, existingComponent?.sasUri ? { newSasUri: existingComponent.sasUri } : {})) return {
 		componentId: existingComponent?.id ?? null,
 		componentName,
 		integrationId,