Files
cleveragents-core/docs/reference/resource_cli.md
T
Jeffrey Phillips Freeman f7d2f63ab8
CI / lint (pull_request) Successful in 15s
CI / typecheck (pull_request) Successful in 28s
CI / security (pull_request) Successful in 23s
CI / quality (pull_request) Successful in 15s
CI / integration_tests (pull_request) Successful in 5m11s
CI / build (pull_request) Successful in 16s
CI / unit_tests (pull_request) Successful in 14m31s
CI / docker (pull_request) Successful in 40s
CI / coverage (pull_request) Successful in 8m18s
CI / lint (push) Successful in 13s
CI / typecheck (push) Successful in 28s
CI / security (push) Successful in 23s
CI / quality (push) Successful in 16s
CI / integration_tests (push) Successful in 4m58s
CI / build (push) Successful in 15s
CI / unit_tests (push) Successful in 15m30s
CI / coverage (push) Has been cancelled
CI / docker (push) Has been cancelled
feat(cli): add resource commands (core)
2026-02-16 16:46:54 -05:00

3.0 KiB

Resource CLI Reference

Resource Type Commands

agents resource type add

Register a custom resource type from a YAML configuration file.

agents resource type add --config ./resource-types/my-type.yaml
agents resource type add --config ./resource-types/my-type.yaml --update

Options:

  • --config, -c (required): Path to the resource type YAML configuration file
  • --update: Update if type already exists
  • --format, -f: Output format (json, yaml, plain, table, rich)

agents resource type remove

Remove a custom resource type. Built-in types cannot be removed.

agents resource type remove local/my-type
agents resource type remove --yes local/my-type

Arguments:

  • name (required): Name of the resource type to remove

Options:

  • --yes, -y: Skip confirmation prompt

agents resource type list

List all registered resource types (built-in and custom).

agents resource type list
agents resource type list --format json

Options:

  • --format, -f: Output format (json, yaml, plain, table, rich)

agents resource type show

Show details of a registered resource type.

agents resource type show git-checkout
agents resource type show --format json local/my-type

Arguments:

  • name (required): Name of the resource type

Options:

  • --format, -f: Output format (json, yaml, plain, table, rich)

Resource Commands

agents resource add

Add a new resource instance of the specified type.

agents resource add git-checkout local/my-repo --path /home/user/repo
agents resource add git-checkout local/my-repo --path /repo --branch main
agents resource add fs-directory local/data --path /data --read-only

Arguments:

  • type_name (required): Resource type name (e.g., git-checkout, fs-directory)
  • name (required): Resource name (e.g., local/my-repo)

Options:

  • --path, -p: Path for physical resources
  • --branch, -b: Branch for git-checkout resources
  • --description, -d: Resource description
  • --read-only: Mark resource as read-only
  • --format, -f: Output format (json, yaml, plain, table, rich)

agents resource list

List registered resources with optional type filtering.

agents resource list
agents resource list --type git-checkout
agents resource list --format json

Options:

  • --type, -t: Filter by resource type
  • --format, -f: Output format (json, yaml, plain, table, rich)

agents resource show

Show details of a specific resource by name or ULID.

agents resource show local/my-repo
agents resource show 01HXYZ1234567890ABCDEFGHIJ

Arguments:

  • resource (required): Resource name or ULID

Options:

  • --format, -f: Output format (json, yaml, plain, table, rich)

agents resource remove

Remove a resource from the registry.

agents resource remove local/my-repo
agents resource remove --yes local/my-repo

Arguments:

  • resource (required): Resource name or ULID to remove

Options:

  • --yes, -y: Skip confirmation prompt