@openserv-labs/client 2.5.0 → 2.5.2

package/README.md

@@ -719,6 +719,82 @@ triggers.manual({
 // { type: 'manual', name: '...', description: '...' }
 ```
 
+## Deploy to OpenServ Cloud
+
+Deploy your agent to the OpenServ managed cloud with a single command:
+
+```bash
+npx @openserv-labs/client deploy [path]
+```
+
+Where `[path]` is the directory containing your agent code (defaults to current directory).
+
+### Prerequisites
+
+1. **`OPENSERV_USER_API_KEY` in `.env`** — The deploy CLI needs this key to authenticate with the platform. If you've already run `provision()` at least once, check your `.openserv.json` file — it contains a `userApiKey` field you can use:
+
+   ```bash
+   # Look for the userApiKey in .openserv.json
+   cat .openserv.json | grep userApiKey
+   ```
+
+   Copy that value into your `.env`:
+
+   ```env
+   OPENSERV_USER_API_KEY=<userApiKey from .openserv.json>
+   ```
+
+   If you haven't provisioned yet, get the key from the [OpenServ platform dashboard](https://platform.openserv.ai/profile/api-keys) instead.
+
+2. **Run `provision()` first** — Your agent must be provisioned at least once before deploying. `provision()` registers the agent on the platform and writes credentials to `.openserv.json`. Starting the agent locally (`npm run dev`) is enough if your code calls `provision()` before `run(agent)`.
+
+### How It Works
+
+The deploy command:
+
+1. Reads `.openserv.json` to find the provisioned agent ID
+2. Creates or reuses a cloud container (saves `OPENSERV_CONTAINER_ID` to `.env`)
+3. Archives your source code (respects `.gitignore`, excludes `node_modules`, `.git`, `.env`, `dist`)
+4. Uploads and installs dependencies in the container
+5. Starts (or restarts) the agent and exposes a public URL
+
+### Deploy Workflow
+
+```bash
+# 1. Run locally once to provision (registers agent + writes .openserv.json)
+npm run dev
+
+# 2. Set OPENSERV_USER_API_KEY in .env
+#    - If you already provisioned: grab userApiKey from .openserv.json
+#    - Otherwise: get it from the platform dashboard
+echo "OPENSERV_USER_API_KEY=your-key" >> .env
+
+# 3. Deploy to cloud
+npx @openserv-labs/client deploy .
+```
+
+On subsequent deploys, the CLI reuses the existing container — it uploads your latest code, reinstalls dependencies, and restarts the agent.
+
+### Environment Variables for Deploy
+
+| Variable                    | Description                              | Required |
+| --------------------------- | ---------------------------------------- | -------- |
+| `OPENSERV_USER_API_KEY`     | Your OpenServ user API key               | Yes      |
+| `OPENSERV_CONTAINER_ID`     | Container ID (auto-set after first deploy) | No       |
+
+### CLI Reference
+
+The package also exposes a `serv` binary:
+
+```bash
+# Via npx
+npx @openserv-labs/client deploy [path]
+
+# Or if installed globally / as a dependency
+serv deploy [path]
+serv --help
+```
+
 ## Environment Variables
 
 | Variable                | Description                           | Required                     |

package/dist/deploy/api-client.d.ts

@@ -4,7 +4,6 @@ export declare class ApiError extends Error {
 }
 export interface ApiClientOptions {
     apiKey: string;
-    agentId?: number;
     orchestratorUrl?: string;
 }
 export interface ContainerInfo {
@@ -34,7 +33,6 @@ export declare class ApiClient {
     constructor(opts: ApiClientOptions);
     createContainer(): Promise<ContainerInfo>;
     getStatus(id: string): Promise<StatusInfo>;
-    findContainerByAgent(agentId: number): Promise<ContainerInfo | null>;
     upload(id: string, tarBuffer: Buffer): Promise<void>;
     exec(id: string, command: string[], timeout?: number): Promise<ExecResult>;
     start(id: string, entrypoint?: string): Promise<void>;

package/dist/deploy/api-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../../src/deploy/api-client.ts"],"names":[],"mappings":"AAIA,qBAAa,QAAS,SAAQ,KAAK;aAGf,UAAU,EAAE,MAAM,GAAG,SAAS;gBAD9C,OAAO,EAAE,MAAM,EACC,UAAU,EAAE,MAAM,GAAG,SAAS;CAKjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAgB;gBAElB,IAAI,EAAE,gBAAgB;IAgB5B,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAIzC,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAI1C,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAepE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpD,IAAI,CACR,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC;IAOhB,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,SAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAM7D,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC;YAUF,OAAO;CAyBtB"}
+{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../../src/deploy/api-client.ts"],"names":[],"mappings":"AAIA,qBAAa,QAAS,SAAQ,KAAK;aAGf,UAAU,EAAE,MAAM,GAAG,SAAS;gBAD9C,OAAO,EAAE,MAAM,EACC,UAAU,EAAE,MAAM,GAAG,SAAS;CAKjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAgB;gBAElB,IAAI,EAAE,gBAAgB;IAa5B,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAIzC,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAI1C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpD,IAAI,CACR,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC;IAOhB,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,SAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAM7D,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC;YAUF,OAAO;CAyBtB"}

package/dist/deploy/api-client.js

@@ -21,9 +21,6 @@ class ApiClient {
         const headers = {
             "x-openserv-key": opts.apiKey,
         };
-        if (opts.agentId != null) {
-            headers["x-openserv-agent-id"] = String(opts.agentId);
-        }
         this.client = axios_1.default.create({
             baseURL: opts.orchestratorUrl || DEFAULT_ORCHESTRATOR_URL,
             headers,
@@ -37,22 +34,6 @@ class ApiClient {
     async getStatus(id) {
         return this.request("GET", `/container/${id}/status`);
     }
-    async findContainerByAgent(agentId) {
-        try {
-            const status = await this.getStatus(String(agentId));
-            return {
-                id: status.id,
-                appName: status.appName,
-                machineId: status.machineId,
-                status: status.status,
-            };
-        }
-        catch (err) {
-            if (err instanceof ApiError && err.statusCode === 404)
-                return null;
-            throw err;
-        }
-    }
     async upload(id, tarBuffer) {
         await this.request("POST", `/container/${id}/upload`, tarBuffer, {
             headers: { "Content-Type": "application/gzip" },

package/dist/deploy/deploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/deploy/deploy.ts"],"names":[],"mappings":"AA8CA,wBAAsB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgH9D"}
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/deploy/deploy.ts"],"names":[],"mappings":"AA8BA,wBAAsB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkG9D"}

package/dist/deploy/deploy.js

@@ -8,27 +8,13 @@ const node_path_1 = __importDefault(require("node:path"));
 const api_client_js_1 = require("./api-client.js");
 const env_js_1 = require("./env.js");
 const logger_js_1 = require("./logger.js");
-const openserv_json_js_1 = require("./openserv-json.js");
 const tar_js_1 = require("./tar.js");
-async function resolveContainer(client, dir, containerId, agentId) {
+async function resolveContainer(client, dir, containerId) {
     if (containerId) {
         logger_js_1.logger.info(`Using existing container: ${containerId}`);
         return { id: containerId, isFirstDeploy: false };
     }
-    if (agentId) {
-        logger_js_1.logger.info(`Agent ID found: ${agentId}. Checking for existing container...`);
-        const existing = await client.findContainerByAgent(agentId);
-        if (existing) {
-            (0, env_js_1.writeContainerId)(dir, existing.id);
-            logger_js_1.logger.info(`  Found container: ${existing.id}`);
-            logger_js_1.logger.info("  Saved to .env\n");
-            return { id: existing.id, isFirstDeploy: false };
-        }
-        logger_js_1.logger.info("  No container found. Creating new container...");
-    }
-    else {
-        logger_js_1.logger.info("Creating new container...");
-    }
+    logger_js_1.logger.info("Creating new container...");
     const container = await client.createContainer();
     (0, env_js_1.writeContainerId)(dir, container.id);
     logger_js_1.logger.info(`  Container ID: ${container.id}`);
@@ -39,17 +25,14 @@ async function deploy(targetPath) {
     const dir = node_path_1.default.resolve(targetPath);
     logger_js_1.logger.info(`Deploying from ${dir}\n`);
     const env = (0, env_js_1.readEnv)(dir);
-    const agentConfig = (0, openserv_json_js_1.readAgentConfig)(dir);
-    const agentId = agentConfig?.id;
     if (!env.apiKey) {
         throw new Error("OPENSERV_USER_API_KEY not found. Set it in your .env file or as an environment variable.");
     }
     const client = new api_client_js_1.ApiClient({
         apiKey: env.apiKey,
-        agentId,
         orchestratorUrl: env.orchestratorUrl,
     });
-    const { id: targetId, isFirstDeploy } = await resolveContainer(client, dir, env.containerId, agentId);
+    const { id: targetId, isFirstDeploy } = await resolveContainer(client, dir, env.containerId);
     let currentStatus;
     let appName;
     if (!isFirstDeploy) {
@@ -119,10 +102,5 @@ async function deploy(targetPath) {
         }
         logger_js_1.logger.info("\nAlready live.");
     }
-    if (agentConfig?.apiKey && agentConfig.id && publicUrl) {
-        logger_js_1.logger.info("\nUpdating agent endpoint URL...");
-        await client.updateEndpointUrl(agentConfig.id, agentConfig.apiKey, publicUrl);
-        logger_js_1.logger.info(`  Agent endpoint set to ${publicUrl}`);
-    }
     logger_js_1.logger.info("\nDeploy complete!");
 }

package/dist/deploy/tar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tar.d.ts","sourceRoot":"","sources":["../../src/deploy/tar.ts"],"names":[],"mappings":"AAwBA,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAerE"}
+{"version":3,"file":"tar.d.ts","sourceRoot":"","sources":["../../src/deploy/tar.ts"],"names":[],"mappings":"AAuBA,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAerE"}

package/dist/deploy/tar.js

@@ -14,7 +14,6 @@ const ALWAYS_EXCLUDE = [
     "dist",
     ".next",
     ".turbo",
-    ".env",
     ".env.example",
     ".env.local",
     ".env.*.local",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openserv-labs/client",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "description": "OpenServ Platform Client - Manage agents, workflows, tasks, and triggers via the OpenServ API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/deploy/openserv-json.d.ts

@@ -1,6 +0,0 @@
-export interface AgentConfig {
-    id: number;
-    apiKey?: string;
-}
-export declare function readAgentConfig(dir: string): AgentConfig | undefined;
-//# sourceMappingURL=openserv-json.d.ts.map

package/dist/deploy/openserv-json.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"openserv-json.d.ts","sourceRoot":"","sources":["../../src/deploy/openserv-json.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAmBpE"}

package/dist/deploy/openserv-json.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readAgentConfig = readAgentConfig;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_path_1 = __importDefault(require("node:path"));
-function readAgentConfig(dir) {
-    const filePath = node_path_1.default.join(dir, ".openserv.json");
-    if (!node_fs_1.default.existsSync(filePath)) {
-        return undefined;
-    }
-    try {
-        const raw = node_fs_1.default.readFileSync(filePath, "utf8");
-        const data = JSON.parse(raw);
-        if (!data.agents)
-            return undefined;
-        const firstAgent = Object.values(data.agents)[0];
-        if (!firstAgent)
-            return undefined;
-        return { id: firstAgent.id, apiKey: firstAgent.apiKey };
-    }
-    catch {
-        return undefined;
-    }
-}