agentc Command Documentation

agentc

The Couchbase Agent Catalog command line tool.

agentc [OPTIONS] COMMAND [ARGS]...

Options

-c, --catalog <catalog>

Directory of the local catalog files.

Default:: '.agent-catalog'

-a, --activity <activity>

Directory of the local activity files (runtime data).

Default:: '.agent-activity'

-v, --verbose

Flag to enable verbose output.

Default:: 0

-i, --interactive, -ni, --no-interactive

Flag to enable interactive mode.

Default:: True

Environment variables

AGENT_CATALOG_CATALOG: Provide a default for -c

AGENT_CATALOG_ACTIVITY: Provide a default for -a

AGENT_CATALOG_VERBOSE: Provide a default for -v

AGENT_CATALOG_INTERACTIVE: Provide a default for -i

See: https://docs.couchbase.com or https://couchbaselabs.github.io/agent-catalog/index.html# for more information.

add

Interactively create a new tool or prompt and save it to the filesystem (output). You MUST edit the generated file as per your requirements!

agentc add [OPTIONS]

Options

-o, --output <output>: Location to save the generated tool / prompt to. Defaults to your current working directory.

--record-kind <record_kind>

Options:: python_function | sqlpp_query | semantic_search | http_request | raw_prompt | jinja_prompt

clean

Delete all or specific (catalog and/or activity) agent related files / collections.

agentc clean [OPTIONS] [[local|db]]... {catalog|activity|all}

Options

--bucket <bucket>: Name of the Couchbase bucket to remove agent-catalog from.

-cid, --catalog-id <catalog_id>: Catalog ID used to remove a specific catalog version from the DB catalog.

-y, --skip_confirm: Flag to delete catalogs without confirm prompting.

--kind <kind>

Kind of catalog to remove versions from.

Default:: 'all'
Options:: tool | prompt | all

Arguments

CATALOG: Optional argument(s)

TYPE_METADATA: Required argument

env

Return all agentc related environment and configuration parameters as a JSON object.

agentc env [OPTIONS]

execute

Search and execute a specific tool.

agentc execute [OPTIONS]

Options

--query <query>: User query describing the task for which tools / prompts are needed. This field or –name must be specified.

--name <name>: Name of catalog item to retrieve from the catalog directly. This field or –query must be specified.

--bucket <bucket>: Name of the Couchbase bucket to search.

--include-dirty

Flag to process and search amongst dirty source files.

Default:: True

--refiner <refiner>

Class to post-process (rerank, prune, etc…) find results.

Options:: ClosestCluster | None

-an, --annotations <annotations>: Tool-specific annotations to filter by, specified using KEY=”VALUE” (AND|OR KEY=”VALUE”)*.

-cid, --catalog-id <catalog_id>

Catalog ID that uniquely specifies a catalog version / snapshot (git commit id).

Default:: '__LATEST__'

-db, --search-db

Flag to force a DB-only search.

Default:: False

-local, --search-local

Flag to force a local-only search.

Default:: False

find

Find items from the catalog based on a natural language QUERY string or by name.

agentc find [OPTIONS] [[tool|prompt]]

Options

--query <query>: User query describing the task for which tools / prompts are needed. This field or –name must be specified.

--name <name>: Name of catalog item to retrieve from the catalog directly. This field or –query must be specified.

--bucket <bucket>: Name of the Couchbase bucket to search.

--limit <limit>

Maximum number of results to show.

Default:: 1

--include-dirty

Flag to process and search amongst dirty source files.

Default:: True

--refiner <refiner>

Class to post-process (rerank, prune, etc…) find results.

Options:: ClosestCluster | None

-an, --annotations <annotations>: Tool-specific annotations to filter by, specified using KEY=”VALUE” (AND|OR KEY=”VALUE”)*.

-cid, --catalog-id <catalog_id>

Catalog ID that uniquely specifies a catalog version / snapshot (git commit id).

Default:: '__LATEST__'

-db, --search-db

Flag to force a DB-only search.

Default:: False

-local, --search-local

Flag to force a local-only search.

Default:: False

Arguments

KIND: Optional argument

index

Walk the source directory trees (SOURCE_DIRS) to index source files into the local catalog. Source files that will be scanned include *.py, *.sqlpp, *.yaml, etc.

agentc index [OPTIONS] [SOURCE_DIRS]...

Options

--prompts, --no-prompts

Flag to (avoid) ignoring prompts when indexing source files into the local catalog.

Default:: True

--tools, --no-tools

Flag to (avoid) ignoring tools when indexing source files into the local catalog.

Default:: True

-em, --embedding-model <embedding_model>

Embedding model used when indexing source files into the local catalog.

Default:: 'sentence-transformers/all-MiniLM-L12-v2'

--dry-run

Flag to prevent catalog changes.

Default:: False

Arguments

SOURCE_DIRS: Optional argument(s)

ls

List all indexed tools and/or prompts in the catalog.

agentc ls [OPTIONS] [[tool|prompt]]...

Options

-db, --search-db

Flag to force a DB-only search.

Default:: False

-local, --search-local

Flag to force a local-only search.

Default:: False

--bucket <bucket>: Name of Couchbase bucket that is being used for agentc functionalities.

Arguments

KIND: Optional argument(s)

publish

Upload the local catalog and/or logs to a Couchbase instance. By default, only tools and prompts are published unless log is specified.

agentc publish [OPTIONS] [[tool|prompt|log]]...

Options

--bucket <bucket>: Name of the Couchbase bucket to publish to.

-an, --annotations <annotations>

Snapshot level annotations to be added while publishing catalogs.

Default:

Arguments

KIND: Optional argument(s)

status

Show the status of the local catalog.

agentc status [OPTIONS] [[tool|prompt]]...

Options

--include-dirty

Flag to process and compare against dirty source files.

Default:: True

-db, --status-db

Flag to check status of catalogs in the Cluster.

Default:: False

--bucket <bucket>: Name of Couchbase bucket that is being used for agentc functionalities.

--compare: Flag to compare the local catalog with the last published catalog.

Arguments

KIND: Optional argument(s)

version

Show the current version of agentc.

agentc version [OPTIONS]