teamx-projects 1.0.0 → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TeamX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,17 +1,49 @@
-# Projects API Client (CommonJS, .js)
+# teamx-projects-api-client
 
-Node 18+ (uses built-in `fetch`).
+A small CLI client for the **TeamX Discord Services Projects API**.
+
+- Node **18+** (uses built-in `fetch`)
+- CommonJS (`.js` + `"type": "commonjs"`)
+- Can **create** projects by zipping a local folder and POSTing to `/api/projects`
+- Can **deploy**, check **status**, and fetch **artifacts**
 
 ## Install
 
 ```bash
-npm i
+npm i -g teamx-projects-api-client
+```
+
+Or use without installing:
+
+```bash
+npx teamx-projects-api-client list
 ```
 
-## Run
+## Usage
+
+The CLI command is:
 
 ```bash
-npx teamx-projects list
+teamx-projects <command> [...args]
+```
+
+Examples:
+
+```bash
+# list projects
+BASE_URL=https://teamx-discord-services.fly.dev teamx-projects list
+
+# create project from a local folder (zips -> base64 -> POST /api/projects)
+teamx-projects create --name my-bot --path ./my-bot --lang ts
+
+# status
+teamx-projects status <projectId>
+
+# artifacts
+teamx-projects artifacts <projectId>
+
+# deploy
+teamx-projects deploy <projectId> --env production --by someone@teamx.com
 ```
 
 ## Commands
@@ -24,7 +56,16 @@ deploy <projectId> --env production|staging|dev --by someone@teamx.com
 create --name <projectName> --path <folderPath> --lang ts|js
 ```
 
-## Env
+## Environment variables
 
 - `BASE_URL` (optional) default: `https://teamx-discord-services.fly.dev`
-- `TEAMX_API_KEY` (optional) Bearer token header
+- `TEAMX_API_KEY` (optional) sends `Authorization: Bearer <token>`
+
+## Publishing (public)
+
+```bash
+npm login
+npm publish --access public
+```
+
+If you use a scoped package (like `@teamx/teamx-projects-api-client`), you still need `--access public` the first time.

package/package.json

@@ -1,14 +1,39 @@
 {
   "name": "teamx-projects",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "type": "commonjs",
-  "description": "Projects API Client for TeamX Discord Services",
-  "main": "index.js",
+  "description": "CLI client for TeamX Discord Services Projects API (CommonJS, Node 18+).",
+  "keywords": [
+    "teamx",
+    "projects",
+    "flyio",
+    "discord",
+    "cli",
+    "api"
+  ],
+  "license": "MIT",
+  "homepage": "https://teamx-discord-services.fly.dev/",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "bugs": {
+    "url": "https://teamx-discord-services.fly.dev/"
+  },
+  "main": "projects-api-client.js",
   "bin": {
-    "teamx-projects": "index.js"
+    "teamx-projects": "projects-api-client.js"
+  },
+  "files": [
+    "projects-api-client.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
   },
   "scripts": {
-    "client": "node index.js"
+    "start": "node projects-api-client.js"
   },
   "dependencies": {
     "yazl": "^2.5.1"

package/{index.js → projects-api-client.js}

@@ -1,6 +1,7 @@
-
+\
+#!/usr/bin/env node
 /**
- * TeamX Projects
+ * TeamX Projects API Client (CommonJS, .js)
  * Node 18+ (built-in fetch)
  *
  * Commands:
@@ -19,13 +20,12 @@ const fs = require("node:fs");
 const path = require("node:path");
 const yazl = require("yazl");
 
-const BASEFIX = "https://teamx-discord-services.fly.dev"
-const BASE_URL = BASEFIX.replace(/\/$/, "");
+const BASE_URL = (process.env.BASE_URL || "https://teamx-discord-services.fly.dev").replace(/\/$/, "");
 const API_KEY = process.env.TEAMX_API_KEY || "";
 
 function usage(exitCode = 1) {
   console.log(`
-TeamX Projects API Client (CJS)
+TeamX Projects API Client
 
 Commands:
   list
@@ -34,6 +34,9 @@ Commands:
   deploy <projectId> [--env production|staging|dev] [--by email]
   create --name <projectName> --path <folderPath> [--lang ts|js]
 
+Env:
+  BASE_URL=${BASE_URL}
+  TEAMX_API_KEY=${API_KEY ? "(set)" : "(not set)"}
 `);
   process.exit(exitCode);
 }