@amykit/plugin-file-store

Work records kept as one file per item.

A plugin for amy. It provides the brief port and the store port.

Install

npm install -g @amykit/plugin-file-store

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

workflows:
  your-profile:
    plugins:
      - "@amykit/plugin-file-store"

Configuration

plugins:
  "@amykit/plugin-file-store":
    briefsDirectory: "briefs"
    directory: "tickets"

| Setting | Type | Required | Default | What it is | | :-- | :-- | :-- | :-- | :-- | | briefsDirectory | string | no | briefs | where the briefs are kept, relative to the state directory. One per workflow, for the same reason the records are | | directory | string | no | tickets | where the records are kept, relative to the state directory. One per workflow, so two profiles under one .amy do not read each other's work |

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