Skip to content

[agentbricks] Document existing project inspection and cleanup commands - #687

Open
shivam5 wants to merge 1 commit into
mainfrom
codex/bugbash-project-lifecycle-independent
Open

shivam5 wants to merge 1 commit into
mainfrom
codex/bugbash-project-lifecycle-independent

Conversation

@shivam5

@shivam5 shivam5 commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Users who lose track of setup can inspect the existing project and workspace state, but the Quickstart does not connect those commands or explain the cleanup boundary. Add one 22-line README section that maps each inspection task to an existing command and explains what deployment deletion removes and retains.

Addresses the guidance portion of ML-70357, based on Chang Shi Lim's feedback, Wish List items 1 and 2: losing track after many setup commands and wanting to remove created resources.

Before After
The Quickstart links deployment listing/details, but users must find onboarding checks, store inspection, and deletion separately. One table connects agent.toml, offline doctor, deployment status/URL, and memory/session store inspection.
The Quickstart does not explain which resources deployment deletion retains. Guidance explains confirmation, App-identity checks for managed Runtime Store cleanup, App retention when cleanup fails, and separate review before deleting owned, unused stores.

This is a documentation-only change. It adds no commands or runtime behavior and does not claim that doctor verifies bindings or deployed readiness. Aggregated project status, automatic project-wide cleanup, evaluation scaffolding, and the resource/cost/evaluation/version overview remain deferred; this PR does not complete the whole ticket.

Validation on the independent branch based on ed3ed6b7:

  • All 10 documented CLI command forms resolve with --help, including the deletion commands' confirmation options.
  • Read-only agentbricks -o json doctor against the existing OpenAI scaffold: 7/7 onboarding checks passed, exit 0.
  • Matched retention and cleanup claims against the current deployments_delete and Runtime Store owner-validation code; verified both command-reference links.
  • git diff --check passed. No delete operation or live resource mutation was performed. The previous broader implementation's deployment/evaluation evidence does not apply to this documentation-only PR.

Comment on lines +160 to +161
Doctor checks local onboarding files offline; it does not verify bindings or deployed resources.
The resource commands query the selected workspace, which can include other projects' resources.

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.

can we add a new column "Details" to the table above into the appropriate rows?

Comment on lines +163 to +167
To remove a deployment, run `agentbricks -p <profile> deployments delete agent-bricks-<name>` and review the confirmation.
Managed Runtime Store cleanup checks the app identity and runs before app deletion; a cleanup failure retains the app for retry.
Memory/session stores, tracing experiments, tools, and source files are retained. Delete a store separately
only after confirming that you own it and no other agent needs it: use [`memory stores delete`](cli.md#agentbricks-memory-stores-delete)
or [`sessions stores delete`](cli.md#agentbricks-sessions-stores-delete), with the same profile and identifier used to inspect it.

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.

can we turn this into a table similar to the inspect section?

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants