Skip to content
CLI reference

CLI reference

One page per command, in alphabetical order. Every page has the same layout: synopsis, flags, aliases, examples and related commands. Flag tables are checked against apigent docs --json from the binary; run apigent docs for the reference that matches your installed version.

Commands

CommandWhat it does
authList auth handlers and their parameters
codegenGenerate Go, Python, JavaScript or curl code from a request
collectionManage collections, their variables, and collection runs
cookiesList, delete and clear stored cookies
deleteRemove a saved request
detectParse a curl command from stdin or a file
diagInspect one recorded execution
diffCompare the latest responses of a request
docsPrint a compact reference of every command and concept
editChange fields of a saved request
envManage environments and their variables
execRun a command with an environment’s variables injected
exportExport requests to a file
extractTest extraction rules against a sample response
graphqlExecute a GraphQL query
grpcExecute a gRPC request
historyShow execution history for a request
importImport from OpenAPI, Insomnia, Bruno, Postman, HAR or apigent exports
initInitialize a project (.apigent/)
listList saved requests
pasteCopy a request as curl to the clipboard
receiveDecrypt a share bundle and import it
renameRename a saved request
runExecute a saved request
saveSave a request under a name
sequenceSet execution order within a collection
shareEncrypt requests to a recipient’s public key
shellLaunch the typed interactive shell
showShow a saved request
sseConnect to a Server-Sent Events endpoint
timelineShow executions across all requests
updateUpdate apigent to the latest release
wsOpen a WebSocket connection

apigent tui is a hidden, non-functional stub; use apigent shell for interactive use.

Global flags

These work with every command, in any position.

FlagShortDescription
--agentJSON output, no prompts, strict masking (or APIGENT_AGENT=1, or run the binary as agentapigent). See Agent mode.
--no-inputNever prompt; fail and name what to pass instead (or APIGENT_NO_INPUT=1)
--project-dirProject root containing .apigent (or legacy .gurl) file storage (or APIGENT_PROJECT_DIR)
--version-vPrint the version

Exit codes

0 success, 1 error, 2 usage error; apigent exec exits with its command’s code. Details and the JSON error shape are in JSON output.