SDKs & CLI
Depllo ships a CLI and a Node/TypeScript SDK, both wrapping the same REST API. (A Python and Go SDK aren't available yet.)
CLI
npm install -g @forjio/depllo-cli
depllo auth login
The CLI signs in through your Forjio (Huudis) account and stores its
session at ~/.depllo/session.json. Commands act on your active
workspace.
# Projects
depllo projects list
# Pipelines
depllo pipeline list <project> # by name, repo, or proj_ id
depllo pipeline run <project> --ref main
depllo pipeline cancel <project> <iid>
depllo pipeline logs <jobId> --follow # tail a job's logs
# Runners
depllo runners list
# Validate a config locally before you push
depllo validate .depllo-ci.yml
Point the CLI at a different environment with DEPLLO_API_URL, or pass a
token directly with DEPLLO_TOKEN (handy in CI).
JavaScript / TypeScript SDK
npm install @forjio/depllo
import { DeplloClient } from "@forjio/depllo";
const depllo = new DeplloClient({
token: process.env.DEPLLO_TOKEN!,
// baseUrl defaults to https://depllo.forjio.com/api/v1
});
// List projects
const { data: projects } = await depllo.projects.list();
// Run a pipeline
const { data: pipeline } = await depllo.pipelines.run("proj_01hx…", {
ref: "main",
variables: { DEPLOY_ENV: "staging" },
});
// Tail a job's logs
const { data: log } = await depllo.jobs.log("job_01hx…");
// Check workspace usage
const { data: usage } = await depllo.usage.get();
Every method returns the family envelope { data, error, meta }. Mutating
calls send an Idempotency-Key automatically. See the
API reference for the full surface.