# cli

cli — Micro CLI reference.

Command reference for **CLI v1.0.0**. [Release source](https://github.com/micro-so/micro-cli/blob/v1.0.0/docs/cli.md).

cli command-line interface

## Synopsis

Command-line interface for cli

```
cli [flags]
```

## Options

```
      --agent-mode             Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDE_CODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
      --api-key x-api-key      Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.
      --color string           Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
  -d, --debug                  Log request and response diagnostics to stderr
      --dry-run                Preview the request that would be sent without executing it (output to stderr)
  -H, --header stringArray     Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
  -h, --help                   help for cli
      --include-headers        Include HTTP response headers in the output
  -q, --jq string              Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
      --no-interactive         Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
  -o, --output-format string   Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
      --server string          Select a server by index (for indexed servers) or name (for named servers)
      --server-url string      Override the default server URL
      --timeout string         HTTP request timeout (e.g., 30s, 5m, 100ms)
      --usage                  Print the CLI Usage schema in KDL format
```

## SEE ALSO

* [cli auth](/docs/reference/cli/auth)	 - Manage authentication credentials
* [cli batch-delete-objects](/docs/reference/cli/batch-delete-objects)	 - Bulk delete records (partial success)
* [cli batch-update-objects](/docs/reference/cli/batch-update-objects)	 - Bulk update records (partial success)
* [cli configure](/docs/reference/cli/configure)	 - Configure authentication credentials and preferences
* [cli count-objects](/docs/reference/cli/count-objects)	 - Total record count for an object type
* [cli create-metadata-property](/docs/reference/cli/create-metadata-property)	 - Create a property definition
* [cli create-metadata-property-option](/docs/reference/cli/create-metadata-property-option)	 - Add an option to a select property
* [cli create-object](/docs/reference/cli/create-object)	 - Create object
* [cli create-view](/docs/reference/cli/create-view)	 - Create a view bundle (view + select/filter/sort)
* [cli delete-metadata-property](/docs/reference/cli/delete-metadata-property)	 - Delete a property definition
* [cli delete-metadata-property-option](/docs/reference/cli/delete-metadata-property-option)	 - Delete a property option
* [cli delete-object](/docs/reference/cli/delete-object)	 - Delete object
* [cli delete-view](/docs/reference/cli/delete-view)	 - Delete a view bundle
* [cli duplicate-object](/docs/reference/cli/duplicate-object)	 - Duplicate object
* [cli explore](/docs/reference/cli/explore)	 - Interactively browse and run commands
* [cli find-object-by-slug](/docs/reference/cli/find-object-by-slug)	 - Find a record by property value
* [cli get-grant](/docs/reference/cli/get-grant)	 - Get grant
* [cli get-import-job](/docs/reference/cli/get-import-job)	 - Get the status of an import job
* [cli get-metadata-properties](/docs/reference/cli/get-metadata-properties)	 - Get metadata properties
* [cli get-metadata-properties-by-object-type](/docs/reference/cli/get-metadata-properties-by-object-type)	 - Get metadata properties by object type
* [cli get-object](/docs/reference/cli/get-object)	 - Get object
* [cli get-view](/docs/reference/cli/get-view)	 - Read a view bundle
* [cli import-objects](/docs/reference/cli/import-objects)	 - Import objects
* [cli list-objects](/docs/reference/cli/list-objects)	 - List records of an object type
* [cli list-view-records](/docs/reference/cli/list-view-records)	 - List records selected by a view (filters and sorts applied; pinned record_order overlaid first)
* [cli patch-metadata-property](/docs/reference/cli/patch-metadata-property)	 - Update a property definition
* [cli patch-metadata-property-option](/docs/reference/cli/patch-metadata-property-option)	 - Update a property option
* [cli patch-object](/docs/reference/cli/patch-object)	 - Patch object
* [cli patch-view](/docs/reference/cli/patch-view)	 - Update a view bundle (select/filter/sort arrays are replaced wholesale when supplied)
* [cli pin-view-record](/docs/reference/cli/pin-view-record)	 - Pin a record to the view (append to record_order)
* [cli query](/docs/reference/cli/query)	 - Query
* [cli reorder-view-records](/docs/reference/cli/reorder-view-records)	 - Bulk reorder pinned records
* [cli restore-object](/docs/reference/cli/restore-object)	 - Restore object
* [cli unpin-view-record](/docs/reference/cli/unpin-view-record)	 - Unpin a record from the view
* [cli update-grant](/docs/reference/cli/update-grant)	 - Update grant
* [cli upsert-object](/docs/reference/cli/upsert-object)	 - Upsert by property value
* [cli version](/docs/reference/cli/version)	 - Print the CLI version
* [cli whoami](/docs/reference/cli/whoami)	 - Display current authentication configuration