@onesi/genesis 0.0.1-stage → 0.2.0

package/README.md

@@ -0,0 +1,29 @@
+# @onesi/genesis
+
+The TypeScript SDK for OneOS. One typed client for every Genesis service, through the Genesis API at `https://os.one.ml/api`.
+
+```sh
+npm install @onesi/genesis@0.2.0
+```
+
+```ts
+import { Genesis, GenesisError } from '@onesi/genesis';
+
+const genesis = new Genesis({ apiKey: process.env.GENESIS_API_KEY });
+try {
+  const projects = await genesis.hives.projects.list();
+} catch (e) {
+  if (e instanceof GenesisError) console.error(e.status, e.code, e.requestId, e.message);
+}
+```
+
+- **Credentials:** create an organization API key in the Console at https://os.one.ml (API keys → Create) and pass it as `apiKey` or `GENESIS_API_KEY`. A WorkOS M2M or session token goes in `token` / `GENESIS_TOKEN`.
+- **Gateway:** defaults to `https://os.one.ml/api`; `https://console.life.one/api` is an alias. Override with `baseUrl` or `GENESIS_BASE_URL`. Only `https://` (or `http://` on loopback) is accepted.
+- **Every operation:** `genesis.call(operationId, input)` reaches any operation in the bundled OpenAPI document (`@onesi/genesis/spec.json`). `operationTable` lists them.
+- **Live service state:** `GET /v1/status` (or `genesis status` in the CLI).
+- **Errors:** every failure is a `GenesisError` with `status`, `code`, `requestId` and a message from the gateway's error catalog. `errorCatalog(e)` adds `required_scope` and `docs_url`.
+- **Runtime:** ESM only, Node.js 20.19 or later.
+
+Use the same version of the SDK, [`@onesi/genesis-cli`](https://www.npmjs.com/package/@onesi/genesis-cli) and [`@onesi/genesis-mcp`](https://www.npmjs.com/package/@onesi/genesis-mcp).
+
+Docs: https://os.one.ml/docs · API reference: https://os.one.ml/api/v1/openapi.json · Error codes: https://os.one.ml/api/v1/errors