Create your first app

Start with Install the developer CLI to set up a supported Node version and the octonodes command. Use matching Octonode CLI and UI SDK versions.

npx @octonodes/cli app create inventory
cd inventory
npm install
npm test
npm run dev

The default is a full Vite app with a hosted page and Node backend. The CLI opens a development preview. Use --use-localhost for local work without a tunnel. The generated page verifies its Octonode workspace session before rendering and registers a Projects route in Studio's app sidebar.

The scaffold includes installConfig.hoistingLimits: workspaces so Yarn 4 workspaces keep build dependencies inside the app. In a Yarn workspace, run yarn install at its root, then yarn workspace inventory test.

Preview in Studio

octonodes login
octonodes app dev --workspace user:<your-user-id>

Studio shows the hosted page under App. Contributions appear in a separate view when declared. A preview starts with no project grants. Follow development access to test selected real projects.

Add a contribution

octonodes app extension add notice --target workspace.block

A full app does not need duplicate app.page or workspace blocks. For a static block with no backend, generate octonodes app create notice --template extension. Extension-only apps currently request no data permissions.

Full apps also support --platform plain and --platform next. Start editing src/server.ts and, for React templates, src/web/App.tsx.

Host your app

Before others can use a published full app, host its page and backend at a permanent public HTTPS URL. Cloudflare and Vercel offer simple hosting options with free plans for eligible usage. See hosting for runtime requirements, build/output settings, environment variables, and complete Cloudflare Worker and Vercel integration recipes. Publishing alone does not deploy your app; extension-only apps do not require a separate host.

Next: configuration, permissions, routing, and hosting.