Skip to content
This repository was archived by the owner on Jun 9, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@ Once deployed visit `localhost:3000/api` to see the available endpoints and thei
The endpoints which work across multiple instances iterate over all organisations listed in `credentials.json`.
Further adjustments might have to be done in the `.env` file.

## Migrations (CLI)

Database migrations can be run via the CLI to apply bulk transformations across all (or selected) instances.

```bash
npm run build
npm run cli -- migrate --help
npm run cli -- migrate run latest-config-formats --dry-run
```

The CLI reads credentials from `src/assets/credentials.json` (same file as the HTTP service).
Org names in `credentials.json` can be set via the optional `name` field and used with `--org`.

See [`src/migration/README.md`](src/migration/README.md) for developer documentation on adding new migrations.

## Development

### Setup to run locally
Expand Down
Loading
Loading