openagentry

§03 · Reference

agentry

Five commands. Every command takes --json. Every failure prints an AgentryError on stderr and exits non-zero.


  1. agentry init

    agentry init [<plugin>...] [--force]

    Create a new workspace. Writes .agentry/workspace.json with the listed plugins and defaultEnv: 'dev'. Refuses to overwrite without --force.

    $ npx agentry init @openagentry/adapter-llm-cli @openagentry/adapter-wiki-fs
    created .agentry/workspace.json (2 plugins · defaultEnv: dev)
  2. agentry version

    agentry version

    Print the installed CLI version and the protocol version it implements. Doesn't need a workspace.

    $ npx agentry version
    agentry 0.1.0-alpha.4
    protocol 1
  3. agentry doctor

    agentry doctor

    Diagnostic checks: Node version, workspace presence, workspace.json shape, plugin resolution. Exits non-zero on any fail.

    $ npx agentry doctor
    node                ok       v22.4.0
    workspace           ok       /abs/path/to/project
    workspace.json      ok       2 plugins, defaultEnv=dev
    @openagentry/cli    ok       0.1.0-alpha.4
    plugins             ok       2/2 resolved
  4. agentry list

    agentry list

    Inspect the on-disk plugin declarations from workspace.json. Doesn't load adapters or read env.

    $ npx agentry list
    @openagentry/adapter-llm-cli      adapter   llm
    @openagentry/adapter-wiki-fs      adapter   wiki
  5. agentry capabilities

    agentry capabilities

    Load every adapter, register them with @openagentry/core, report what is available. categories[cat] is the default (last registered, mirrors useAdapter); adaptersByCategory[cat] is the full set in declaration order.

    $ npx agentry capabilities --json
    {
      "categories": {
        "llm":  { "adapterId": "llm-cli", "pluginName": "@openagentry/adapter-llm-cli" },
        "wiki": { "adapterId": "wiki-fs", "pluginName": "@openagentry/adapter-wiki-fs" }
      },
      "adaptersByCategory": {
        "llm":  [{ "adapterId": "llm-cli",  "pluginName": "@openagentry/adapter-llm-cli" }],
        "wiki": [{ "adapterId": "wiki-fs", "pluginName": "@openagentry/adapter-wiki-fs" }]
      },
      "loadErrors": []
    }