mirror of
https://github.com/trycua/lume.git
synced 2026-02-15 10:49:42 -06:00
174ae253ba
* feat: auto-generated SDK docs, Python CLI, and docs improvements
- Add auto-generated SDK reference pages (computer-sdk, agent-sdk) with version selector
- Add Python CLI package (cua-cli) with auth, sandbox, image, MCP commands
- Deprecate TypeScript CLI in favor of Python CLI
- Add versioned docs (agent-sdk v0.3-v0.7, computer-sdk v0.3-v0.5)
- Rename cloud-cli to cli in docs
- Add mobile header fix with sidebar toggle
- Restructure guide pages (quickstart, self-hosted-sandboxes)
- Add redirects for old /api URLs
- Update workflows, lume docs, cuabench docs, desktop sandbox docs
* refactor: auto-generate CLI index page like computer/agent SDKs
Change CLI docs to use the same auto-generated index.mdx pattern as
computer-sdk and agent-sdk. Removes hand-written index page that could
become stale, and deletes the separate api.mdx.
* fix: rename "Cua Bench API Reference" to "API Reference" in menu
* fix: update lume examples to macos-tahoe-vanilla and shorten page titles
- Replace macos-sequoia-vanilla:latest with macos-tahoe-vanilla:latest
in lume docs and generator
- Rename "Lume CLI Reference" to "CLI Reference"
- Rename "Lume HTTP API Reference" to "API Reference"
* feat: rename CuaBot to Cua-Bot and add to dropdown selector
- Rename CuaBot to Cua-Bot in docs meta.json and content pages
- Add Cua-Bot entry to the header dropdown selector
* refactor: restructure Cua-Bot docs to match Cua/Cua-Bench pattern
Reorganize cuabot docs from flat structure into guide/getting-started/
hierarchy matching other collections:
- cuabot.mdx → guide/getting-started/introduction.mdx
- install.mdx → guide/getting-started/installation.mdx
- Add meta.json files with proper icons and structure
- Update dropdown selector href to new path
* feat(docs): add auto-generated API reference, changelog, and versioning for Cua-Bot
Add TypeScript SDK doc generator (regex-based, no compiler dependency) and
configure cuabot for changelog generation and versioned docs snapshots.
* feat(ci): add cuabot to docs drift check and improve failure message
Wire cuabot into CI path triggers, runner config, and changed-file
detection. Add --check mode to typescript-sdk.ts for drift comparison.
Update failure banner with per-library and versioning commands.
* fix: resolve Python lint issues (black, ruff)
Run black formatting on 12 files, fix ruff F841 (unused variables) in
tests, and add TYPE_CHECKING import for FastMCP forward references.
* fix: resolve TS typecheck and Lume Swift 6 CI failures
- typescript-typecheck.js: build @trycua/core before running typecheck
so its dist/ type declarations are available for @trycua/computer
- SSHClient.swift: avoid crossing Sendable boundary with NIOSSHHandler
by keeping handler access + createChannel within flatMap on the event
loop, fixing Swift 6 strict concurrency errors
* fix: TS typecheck pnpm version strict mode and Lume mock conformance
- Set COREPACK_ENABLE_STRICT=0 in typecheck script to allow pnpm 9.x
to run commands in workspace packages declaring pnpm 10.x
- Update MockVNCService.sendText signature to match protocol (add
delayMs parameter)
* fix: run prettier formatting and ignore auto-generated docs files
Format all files to pass prettier 3.8.1 check. Add docs/.source/ and
docs/next-env.d.ts to .prettierignore (auto-generated, not editable).
* fix: restore MDX comment syntax broken by prettier
Prettier 3.8.1 converts {/* */} to {/_ _/} in MDX files, which breaks
the acorn parser. Restore all comments and add *.mdx to .prettierignore.
* fix: regenerate docs to pass drift check after prettier revert
* fix: CI docs check fetch-depth, regenerate Lume docs, fix header layout shift
- Use fetch-depth: 0 in CI checkout so git tags are available for
version discovery (was using fetch-depth: 2, causing version fallback)
- Regenerate Lume docs from local Swift build (0.2.75 → 0.2.76)
- Fix header product selector layout shift with consistent icon/text sizing
* fix: format custom-header.tsx with prettier
* fix: use arch-agnostic JAVA_HOME for arm64 Docker build
The openjdk package writes the arch-specific path (e.g. java-17-openjdk-amd64)
to /etc/environment, which sdkmanager sources, overriding the Dockerfile ENV.
Create an arch-agnostic symlink and re-export JAVA_HOME in the sdkmanager RUN
step to ensure it works on both amd64 and arm64.
* fix: skip emulator package on arm64 (not available for that arch)
The Android emulator SDK package is only published for amd64.
Conditionally install it based on dpkg --print-architecture.
* ci: retrigger cuabot docker build
docs
This is a Next.js application generated with Create Fumadocs.
Run development server:
npm run dev
# or
pnpm dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the result.
Explore
In the project, you can see:
lib/source.ts: Code for content source adapter,loader()provides the interface to access your content.app/layout.config.tsx: Shared options for layouts, optional but preferred to keep.
| Route | Description |
|---|---|
app/(home) |
The route group for your landing page and other pages. |
app/docs |
The documentation layout and pages. |
app/api/search/route.ts |
The Route Handler for search. |
Fumadocs MDX
A source.config.ts config file has been included, you can customise different options like frontmatter schema.
Read the Introduction for further details.
Setup Telemetry
We use PostHog for telemetry to improve the clarity and structure of our documentation. Start by copying the .env.example and adding in your PostHog API key and host.
cp .env.example .env
Learn More
To learn more about Next.js and Fumadocs, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
- Fumadocs - learn about Fumadocs