@amykit/plugin-command

Any command line tool, reached by a name the config allows.

A plugin for amy. It provides the commands port.

Install

npm install -g @amykit/plugin-command

Then name it in ~/.amy/config.yaml:

workflows:
  your-profile:
    plugins:
      - "@amykit/plugin-command"

Configuration

plugins:
  "@amykit/plugin-command":
    allow: <record>
    cwd: ""
    timeoutMs: 300000

| Setting | Type | Required | Default | What it is | | :-- | :-- | :-- | :-- | :-- | | allow | record | yes | | the commands a workflow may run, by name. The name is what a workflow asks for; the value is the command line it stands for, and this is the only place one is written | | cwd | string | no | "" | where a command runs when it does not say, defaulting to the state directory | | timeoutMs | number | no | 300000 | how long one command may run before it is given up on |

Every field is checked at boot against the schema this package declares. A key that is not one of the above is a refusal naming the plugin and the key, not a setting that silently never applied.

Where the reasoning is

• Writing a plugin
• Reference: plugins
• Ports and the registry

Licence

MIT