Skip to navigation

Command reference

This reference documents Deel CLI 0.1.1. Commands are grouped by the resource they act on. Run deel --help, or deel <group> <action> --help, for the same information in the terminal; add --json to get a command’s contract as JSON for an AI agent or a script.

Session and job commands

Manage the token and follow asynchronous jobs by id.

CommandDescription
deel auth statusValidate the current token and report its source
deel auth loginValidate a token and store it in the OS keychain
deel auth logoutRemove the stored token for the selected environment
deel job status <id>[,<id>]Fetch one or more jobs by id
deel job listList recent jobs

Resource commands

Create and inspect Deel resources. The Operation column shows the API operation each command calls.

CommandOperationDescription
deel adjustments create --invoicePOST /adjustments/invoiceCreate a single invoice adjustment
deel adjustments create --payrollPOST /adjustments/payrollCreate a payroll adjustment
deel adjustments create-bulk --invoicePOST /adjustments/invoice/bulkCreate invoice adjustments in bulk (asynchronous)
deel adjustments create-bulk --payrollPOST /adjustments/payroll/bulkProcess bulk payroll adjustments (asynchronous)
deel jobs listGET /jobsList jobs
deel jobs statusGET /jobs/{job_id}Retrieve a job

Global options

Flags such as --env, --input, --fields, and --jq are accepted by every command. See Global options.

Requesting a new command

The CLI covers a small, growing set of Deel operations. To request one, open an issue in the deel-cli repository with the operation’s method and path from the API reference.