@makerx/ds

CLI for the data-streams platform.

Install

Requires Node.js 22+. Pick one of three patterns depending on how you want the CLI scoped:

Global install — one shared copy on your machine, every project uses the same version:

npm install -g @makerx/ds
ds init

One-shot via npx — nothing installed; npm fetches and runs it on demand. Best for trying it out, single-command usage, or CI steps where you don't want a global state:

npx @makerx/ds init

Project-local devDependency — the version is pinned in package.json so every contributor and every CI run uses the same ds. Recommended for any team project (this is also what ds quickstart sets up automatically):

npm install --save-dev @makerx/ds

Then add a script in package.json:

{
  "scripts": {
    "ds": "ds",
  },
}

…and invoke it with npm run ds -- <args> or npx ds <args> from inside the project. Both resolve to ./node_modules/.bin/ds, so the project's pinned version always wins over any global one.

Quick start

Scaffold a new project (Vite + React + TypeScript + Tailwind, with ds wired in as a devDependency and an AI-coding-agent context primed):

ds quickstart my-app --instance-url https://your-data-streams-instance.com/
cd my-app && npm run dev

Or work inside an existing project (using whichever install pattern you picked):

ds init                                # scaffold .ds/, agent guidance, .gitignore entries
ds login                               # interactive Entra device-code (skip with DS_TOKEN)
ds doctor                              # verify config / discovery / auth / network

ds model add Client --domain sales --description "A customer."
ds model field add Client email --type string --format email --required

ds apply --dry-run                     # preview the plan against the live API
ds apply                               # push it

Run ds --help for the full command list.

Output discipline

Stdout carries a command's result (structured JSON, NDJSON, or a self-contained report); progress, warnings, prompts, and errors go to stderr. Side-effect-only commands (login, init, apply, model add / edit, …) emit nothing on stdout, so ds <cmd> > out.txt always yields a clean parseable file or an empty one.

Exit codes

| Code | Meaning | | ---- | --------------------------------------------------------- | | 0 | success | | 1 | user error (bad config, invalid input, missing file) | | 2 | auth failure (no token, expired, missing role) | | 3 | network failure (DNS, connect, TLS, timeout) | | 4 | server error (non-2xx or malformed payload) | | 5 | breaking change refused — re-run with --force to accept |

License

© MakerX Pty. Ltd. All Rights Reserved.