@akal/supaforge 0.0.37 → 0.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -367,13 +367,18 @@ as `io.github.akalsoftware/supaforge`.
367
367
 
368
368
  The server exposes these tools:
369
369
 
370
- | Tool | Annotation |
371
- | --- | --- |
372
- | `scan_drift` | Read-only |
373
- | `get_check_result` | Read-only |
374
- | `apply_fixes` | Destructive. Previews unless `dryRun: false` |
375
- | `take_snapshot` | Writes files |
376
- | `create_migration` | Writes files |
370
+ | Tool | What it does | Annotation |
371
+ | --- | --- | --- |
372
+ | `list_environments` | The environments in the config, without their credentials | Read-only |
373
+ | `diff` | Every difference, with the plan `sync` would run | Read-only |
374
+ | `get_check_result` | One check's result from the last `diff` or `sync` | Read-only |
375
+ | `sync` | Runs the plan on the target; `prove: true` rehearses it on a copy first | Destructive |
376
+ | `create_migration` | Writes the drift as a migration file, as `migrate create` does | Writes files |
377
+ | `take_snapshot` | Snapshots an environment to local files | Writes files |
378
+
379
+ `diff` and `sync` take the same arguments, so the plan an agent shows you is
380
+ the plan that runs. Fixes that drop tables or columns are held back unless
381
+ `allowDestructive` is set.
377
382
 
378
383
  It reads `supaforge.config.json` in the directory given by `--project` (or the
379
384
  one it starts in), and refuses a `configPath` from a client unless started