Phase 1 — Choose your workflow
Time: ~5 minutes
Prerequisites: Phase 0 complete
You'll need: Access to the Dashboard (optional)
This phase captures how you want to use Restormel: in my app, in my terminal, or in my agent or IDE. The choice drives which phases you do next and surfaces the right quick-links in the dashboard.
Step 1.1 — Choose a usage path
When you open the Dashboard overview, you see: "How do you want to use Restormel?"
- In my app — You integrate via the SDK and Cloud API. Focus on the Keys walkthrough. The CLI is still useful for validation and routing explain.
- In my terminal — You want the CLI for doctor, validate, models list, routing explain. Proceed to Phase 2 — CLI.
- In my agent or IDE — You want MCP tools. Proceed to Phase 3 — MCP.
You can change your answer later (Dismiss or Change on the dashboard).
Step 1.2 — Persist your selection
If you are in the Dashboard, click one of the three options. Your choice is stored in localStorage and the overview shows follow-up links (SDK docs, CLI quickstart, MCP setup). If you are implementing with an agent, the agent can add a config or env placeholder (e.g. RESTORMEL_USAGE_PATH=) so later phases know which path to configure.
How to test
Reload the dashboard overview. Your selection is still there. Click "Change" and pick a different option; confirm the links update.
Prompts for this phase
Optional. Use if a coding agent should record the usage path in your repo.
Checkpoint
You now have a chosen usage path (app / terminal / agent), persisted selection, and a clear next step: Phase 2 (CLI), Phase 3 (MCP), or the Keys walkthrough (app).