Skip to content

docs(cli): document backend framework selection - #965

Open
AbhinRustagi wants to merge 1 commit into
be-framework-selectfrom
be-framework-docs
Open

docs(cli): document backend framework selection#965
AbhinRustagi wants to merge 1 commit into
be-framework-selectfrom
be-framework-docs

Conversation

@AbhinRustagi

@AbhinRustagi AbhinRustagi commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

What

Documents --backend-framework across the CLI reference and the package and template READMEs.

Changes

  • Document the flag and its values, and that the framework prompt follows the template prompt — non-interactive runs default to default.
  • Add a matrix mapping each value to the route it produces for the Cloud and self-hosted templates.
  • Add a Conversation storage section: Cloud is the durable store for every Cloud variant, while self-hosted keeps messages in memory for the page session only.
  • Deployment guidance points at Vercel throughout.
  • Fix the Cloud template README, which told people to cp .env.example .env.local — the CLI writes .env, and no .env.example ships.

Docs only. Migrated from #785.

Test Plan

  • Verified locally

prettier --check clean, which is what docs CI gates on cli.mdx. Cross-checked every behavioural claim against the code in #964 — the default fallback, the prompt ordering, and the THESYS_API_KEY / OPENAI_API_KEY gate.

Checklist

  • I updated docs/README when needed
  • I considered backwards compatibility

@vercel

vercel Bot commented Aug 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
openui-docs Ready Ready Preview Aug 14, 2026 11:19am

Request Review

Cover the `--backend-framework` flag across the CLI reference and the
package/template READMEs.

- Document the flag, its values, and that the framework prompt follows
  the template prompt (non-interactive runs default to `default`).
- Add a Backend frameworks matrix mapping each value to the route it
  produces for the Cloud and self-hosted templates.
- Add a Conversation storage section: Cloud is the durable store for
  every Cloud variant; the self-hosted variants keep messages in memory
  for the page session only.
- Note that an immediate start now requires `THESYS_API_KEY` or
  `OPENAI_API_KEY`.
- Deployment guidance targets Vercel: both Vercel AI SDK variants are
  ordinary Next.js deployments, and the LangGraph variants deploy their
  Next.js frontend to Vercel with `LANGGRAPH_API_URL` pointed at the
  Agent Server.
- Fix the Cloud template README, which told users to `cp .env.example
  .env.local`; the CLI writes `.env` and no `.env.example` is shipped.

Docs only. Migrated from PR #785 (visharad/th-2051-route-replacement).

Co-Authored-By: Visharad Kashyap <154831195+vishxrad@users.noreply.github.com>
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.

1 participant