Skip to content

docs: remove cli audit-list #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bercianor merged 2 commits into from
Sep 13, 2026
Merged

docs: remove cli audit-list #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8848bd8
docs: remove cli audit-list
davidfrigolet Aug 12, 2026
35b9b30
docs: mark audit list as enterprise-only feature
davidfrigolet Aug 17, 2026
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
6 changes: 5 additions & 1 deletion docs/cli/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,12 @@ flamingock execute apply --jar ./my-app.jar -J -Xmx1g -- --spring.profiles.activ

List audit entries from the change history.

:::note
Enterprise feature. Requires Flamingock Cloud or Self-Hosted Edition.
:::

| Option | Short | Required | Description |
|--------------|-------|----------|-----------------------------------------------------------------------------|
|--------------|-------|----------|-------------------------------------------------------------------------------|
| `--jar` | `-j` | Yes | Path to the application JAR |
| `--history` | | No | Show full chronological history instead of snapshot |
| `--since` | | No | Filter entries since date (ISO-8601: `yyyy-MM-dd` or `yyyy-MM-ddTHH:mm:ss`) |
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/coming-from-mongock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,13 +350,13 @@ After the first Flamingock run against a copy of your Mongock audit history, ver
Instead of inspecting the store manually, use the Flamingock CLI against your application JAR as the source of truth:

@bercianor bercianor Aug 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence now overstates what the CLI can validate. With audit list removed, issue list can only report inconsistent audit states, not validate imported audit history or confirm that changes were applied.

Could we narrow the wording accordingly, for example: “Use the CLI to identify inconsistent audit states”?


```bash
# Snapshot of the current audit state
# Snapshot of the current audit state (Enterprise feature — Cloud or Self-Hosted Edition)
flamingock audit list --jar ./my-app.jar

# Optional: full audit history
# Optional: full audit history (Enterprise feature)
flamingock audit list --jar ./my-app.jar --history

# Optional: detect inconsistent states that require attention
# Detect inconsistent states that require attention
flamingock issue list --jar ./my-app.jar
```

Expand Down Expand Up @@ -384,8 +384,8 @@ Successful migration signal: legacy Mongock changes appear as executed, with no
Practical verification flow:

1. Run the application once with Flamingock enabled.
2. Run `flamingock audit list --jar ./my-app.jar`.
3. Confirm legacy Mongock changes that had already executed appear in the output and were not re-executed.
2. Run `flamingock audit list --jar ./my-app.jar` (Enterprise) or check application logs / the target system directly.
3. Confirm legacy Mongock changes that had already executed appear as executed and were not re-executed.
4. Confirm previously pending legacy changes now appear as executed.
5. Run `flamingock issue list --jar ./my-app.jar` and confirm no inconsistent audit states.

Expand Down