teamx-projects-api-client
v1.0.1
Published
CLI client for TeamX Discord Services Projects API (CommonJS, Node 18+).
Maintainers
Readme
teamx-projects-api-client
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
npm i -g teamx-projects-api-clientOr use without installing:
npx teamx-projects-api-client listUsage
The CLI command is:
teamx-projects <command> [...args]Examples:
# 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 [email protected]Commands
list
status <projectId>
artifacts <projectId>
deploy <projectId> --env production|staging|dev --by [email protected]
create --name <projectName> --path <folderPath> --lang ts|jsEnvironment variables
BASE_URL(optional) default:https://teamx-discord-services.fly.devTEAMX_API_KEY(optional) sendsAuthorization: Bearer <token>
Publishing (public)
npm login
npm publish --access publicIf you use a scoped package (like @teamx/teamx-projects-api-client), you still need --access public the first time.
