Releases: getlark/cli
Releases · getlark/cli
v0.5.0
v0.5.0 — jobs command group
This release adds a new top-level jobs command group for managing long-running jobs on the getlark platform, starting with workflow_import jobs for bulk-creating workflows from a JSON file.
New commands
getlark jobs create --name <name> --input-file <path>— create a job from an inline JSON input file (sent asapplication/json).getlark jobs upload --name <name> --file <path>— create a job by uploading an input file asmultipart/form-datato/jobs/upload. The original filename is preserved on the job and visible fromjobs get.getlark jobs validate --file <path>— validate an input file against the job's schema without creating a job. Exits non-zero when the report'svalid: false.getlark jobs list [--limit] [--offset] [--status …]— list jobs, with a repeatable--statusfilter (pending,running,completed,failed,cancelled).getlark jobs get <job_id>— fetch a job's full JSON, including the newdashboard_urlfield.getlark jobs cancel <job_id>— cancel a pending or running job.
All commands accept --type, currently fixed to workflow_import (the only supported job type).
workflow_import input schema
The same JSON file is accepted by jobs create, jobs upload, and jobs validate:
json { "workflows": [ { "name": "Checkout smoke", "description": "Verify checkout works end-to-end with a test card.", "mode": "ai_driven", "secret_contexts": ["staging"], "group_id": "wgrp_01h..." } ] }
mode is "ai_driven" or "deterministic"; secret_contexts and group_id are optional. No additional properties are accepted.
API client changes
GetLarkClientgainedcreateJob,listJobs,getJob,cancelJob,uploadJob, andvalidateUploadJobmethods (seesrc/api/client.ts).- The internal request layer now supports
FormDatabodies (boundary is set automatically by fetch) and repeated query params (used for multi-valuestatusfilters). - New types in
src/api/types.ts:JobType,JobStatus,JobResource(includes the new requireddashboard_url),ListJobsResponse,WorkflowImportInput,CreateJobRequest,JobValidationReport, andJobValidationMessage.
Docs & misc
- README has a full
jobssection covering every subcommand, the input schema, and recommendedvalidate-before-createworkflow. .gitignorenow excludeslocal-testing/for ad-hoc CLI sample inputs.
Compatibility
- No breaking changes to existing
workflows,workflow-groups,secret-contexts,login,logout, orconfigcommands. - Still requires Node.js ≥ 18 and uses the same
X-API-Keyauth and~/.getlark/config.jsonprofile store as 0.4.x.