Skip to content

Get started

You need Node.js 20 or newer and a Sollar account. You do not need an approved developer entity, an administrator, or permission from anyone. That comes later, and only if you publish publicly.

Terminal window
npm install -g @sollar/cli
sollar login

sollar login opens your system browser for OIDC sign-in. The token lives in your OS keychain. Nothing is written to a config file — no key, no token, no secret, ever.

Terminal window
sollar org create --name "My sandbox"

A test organisation is a throwaway tenant with synthetic users, synthetic conversations and synthetic files. Inside it:

  • permission and configuration changes take effect immediately, with no administrator review;
  • there is no path to production data, by credential or by network;
  • development-signed packages are accepted.

You may hold three at a time. They are real infrastructure, so they are not free.

Terminal window
sollar init my-mini-app # or: --template react | vue
cd my-mini-app

You get:

my-mini-app/
├── manifest.json the contract: identity, permissions, network, actions
├── sollar.config.json build config — commit this
├── .sollar/local.json your machine's preferences — gitignored
├── AGENTS.md instructions for coding agents
├── CLAUDE.md one line: @AGENTS.md
└── src/
├── main.ts
├── actions.ts your sollar.actions.handle() registrations
└── pages/
Terminal window
sollar dev

This starts a local server and opens your mini app in a Sollar client in developer mode. You get hot reload, and you get the standard web toolchain: Chrome DevTools on Android, Safari Web Inspector on iOS. Sollar does not ship its own debugger, because it does not need to — the runtime is the web platform.

Change a CSS file and it applies without reloading. Change manifest.json and the app reloads completely: permissions, routes and the network allowlist are re-validated by native code, and applying that hot would let the runtime and your source disagree about what is authorised.

Terminal window
sollar seed --profile erp

Populates the test organisation with people, an org chart, conversations and files. Use it. The alternative — pointing at a real staging system “just to see it work” — is how test credentials end up in production code.

Terminal window
sollar validate # manifest, CSP, network allowlist, SBOM
sollar conformance # runs against both engines

sollar conformance matters more than it looks. iOS runs JavaScriptCore and Android runs V8 — the engines differ, permanently, because Apple Guideline 2.5.6 mandates WebKit. The conformance suite is how you find out before your users do.