Extending Agentia

Scaffold a new plugin with the generator. It asks for the package name, description, author, command topic, and command name, then creates the project and installs its dependencies.

The destination can be a relative or an absolute path:

The generator creates a ready-to-build oclif plugin with this structure:

my-plugin/
├── src/
│   ├── commands/
│   │   └── <topic>/
│   │       └── <command>.ts
│   └── index.ts
├── package.json
├── package-lock.json
├── tsconfig.json
├── .gitignore
└── README.md

The sample command (src/commands/<topic>/<command>.ts) extends the oclif Command class and declares its description, examples, args and flags, then does the work in run(). Add new commands by creating more files in the same shape under src/commands.

The sample extends AgentiaCommand from the Agentia plugin SDK, which gives you --json output and spinners for free. It gets Agentia from the SDK and reads a work item. Nothing to configure in code.

import {AgentiaCommand, getAgentiaHost} from '@copado/agentia-plugin-sdk'

export default class StoryShow extends AgentiaCommand {
  static override description = 'Show the active user story'

  public async run() {
    const host = getAgentiaHost()
    const story = await host.work.getWorkItem()
    this.display(() => {
      this.log(host.format.table(
        [{field: 'name', header: 'Story'}, {field: 'status', header: 'Status'}],
        [story],
      ))
    })
    return story
  }
}

What the plugin needs in package.json

Once the project is generated, build it and link it into your local Agentia CLI:

Then run the generated sample command:

Re-run npm run build after every change to your TypeScript files.

Publish to npm with provenance, then list the plugin in the Marketplace.