docs: Deploy and activate on aomi CLI page - #13
Merged
Merged
Conversation
Adds build/deploy-cli.mdx, a full CLI deploy walkthrough (connect, deploy, activate, status) with the real command output at every step, a Tokens section (app vs platform token), and an honest Secrets section. Verified against a live end-to-end community deploy on 2026-07-06. Retitles the existing build/deploy page to 'Deploy and activate on Dashboard' and replaces its inline CLI steps with a pointer to the new page, so each deploy path has one home. docs.json places the CLI page directly below the dashboard page under Build on Aomi. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR splits the deployment docs into two clear paths by adding a dedicated CLI walkthrough page and refocusing the existing deploy page on the no-code dashboard flow, with navigation updated to include the new CLI page under Build on Aomi.
Changes:
- Added
build/deploy-cli.mdxwith an end-to-end CLI deploy flow (connect → deploy → activate → status) and supporting sections (tokens, secrets, troubleshooting). - Updated
build/deploy.mdxto be “Deploy and activate on Dashboard” and replaced the inline CLI walkthrough with a pointer card to the new CLI page. - Inserted
build/deploy-cliintodocs.jsonnav under Build on Aomi.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
docs.json |
Adds the new CLI deploy page to the Build on Aomi navigation. |
build/deploy.mdx |
Retitles/reframes the page for the dashboard flow and links out to the new CLI guide. |
build/deploy-cli.mdx |
Introduces the full CLI deployment walkthrough, including tokens/secrets/troubleshooting guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Step 7: check status and see it live | ||
|
|
||
| ```bash | ||
| aomi-build deploy status |
| deploy state : ready | ||
| - my-app (apps-144438915-r0ed7523bdf-my-app-7601d95b9abd) | ||
| local : activated=true | ||
| backend : active=true artifact_ready=true loaded |
| backend : active=true artifact_ready=true loaded | ||
| ``` | ||
|
|
||
| Add `--json` for machine readable output. You want `active`, `artifact_ready`, and `loaded` all true. |
| `aomi-build deploy` activates for you. You only run activate yourself if you stopped after the build, or you are activating a specific release: | ||
|
|
||
| ```bash | ||
| aomi-build deploy activate \ |
| | `app token is not authorized for platform-level actions` | Your token is app scoped; activation needs platform scope. | Ask the Aomi team for a platform token and use it. See [Tokens](#tokens). | | ||
| | `no Cargo.toml found at <repo>/Cargo.toml` | Your App is in a subdirectory. | Move `Cargo.toml`, `aomi.toml`, and `src/` to the repo root and push again. See [Step 2](#step-2-lay-out-your-repo). | | ||
| | SDK mismatch | Your pin differs from the platform. | Run `aomi-build sdk fix --backend https://api.aomi.dev`, commit, deploy again. Or pass `--fix-sdk` on deploy. | | ||
| | Deploy hangs at "waiting" after CI is green | Old CLI without the CI fallback. | Reinstall the CLI (Step 1). As a one off, kill the process and run `aomi-build deploy activate` by hand. | |
| | `deploy needs an app source id` | The backend cannot find your connected repo. | Pass `--repo you/my-app`, or run `aomi-build source sync --platform community --repo you/my-app`. | | ||
| | Status shows `activate: false` | Activate never ran or failed. | Run [Activate by hand](#activate-by-hand). | | ||
| | Deploy uses old code | You did not push your latest commit. | `git push`, deploy again. | | ||
| | Everything true except `loaded` | The runtime did not load the plugin. | Run `aomi-build deploy status --json` and share the deployment id and release tag with the team. | |
| @@ -0,0 +1,333 @@ | |||
| --- | |||
| title: Deploy and activate on aomi CLI | |||
| - **The portal.** A no-code path in your browser. Click Preflight, Deploy, Activate. This is the recommended path for your first deploy. | ||
| - **The CLI.** `aomi-build connect`, then `aomi-build deploy`, then `aomi-build activate`. This is the scriptable path once you know the flow. | ||
| - **The dashboard.** A no-code path in your browser. Click Preflight, Deploy, Activate. This page covers it, and it is the recommended path for your first deploy. | ||
| - **The CLI.** `aomi-build connect`, then `aomi-build deploy`. The scriptable path once you know the flow. It has its own page: [Deploy and activate on aomi CLI](/build/deploy-cli). |
| The backend fetches your release, validates it, and loads it. It reads the release tags from `.aomi/deployment.json`, so you usually pass nothing else. | ||
| </Step> | ||
| </Steps> | ||
| <Card title="Deploy and activate on aomi CLI" href="/build/deploy-cli" icon="terminal"> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a dedicated Deploy and activate on aomi CLI page and splits the CLI path out of the existing deploy page.
Why
The old page mixed the no-code dashboard flow and the CLI flow on one page. Each now has one home. The CLI page is written from a verified live end-to-end deploy on 2026-07-06 (Monad One-Shot to prod), so every command and every output block is real, not illustrative.
Verified
Notes for review
🤖 Generated with Claude Code