Docs/Getting startedv1.0.0-rc.1

Installation

These instructions target @tagna/udiot 1.0.0-rc.1, an evaluation release, not stable 1.0. Use Node.js 22.17.0 or newer and npm 9 or newer.

Public npm installation

No GitHub account, npm token, or private registry access is required.

npm install --save-exact @tagna/udiot@1.0.0-rc.1
npm install --save-dev typescript @types/node

To follow the prerelease channel explicitly, use npm install @tagna/udiot@next. To select the non-prerelease channel, use npm install @tagna/udiot@latest. An unqualified install follows latest, not next; inspect the current registry tags with npm view @tagna/udiot dist-tags. Commit your lockfile.

If an older setup mapped the @tagna scope to GitHub Packages, remove that mapping from your project/user npm configuration, or replace it with:

@tagna:registry=https://registry.npmjs.org/

Do not add authentication tokens to consumer projects for this public package. Never commit real credentials.

ESM and TypeScript

Set "type": "module" in your application's package.json. Use the TypeScript configuration, then compile and run:

npx tsc -p tsconfig.json
node dist/main.js

Start with the complete quick-start examples. Legacy decorators need TypeScript compilation with experimentalDecorators and emitDecoratorMetadata; Node's built-in type stripping is not a substitute.

Entry points and optional integrations

Choose an entry point from the public API guide. Use @tagna/udiot/browser for browser bundles; the root and server-oriented entry points can load Node dependencies. Database drivers, AI providers, and bundlers have their own configuration and service requirements. For example, Anthropic support requires the optional @anthropic-ai/sdk peer dependency.

CLI

After the local install:

npx --no-install udiot --help
npx --no-install udiot generate --help

The package contains a compiled CLI. Source-loader fallback is for framework contributors, not a consumer installation step. The RC CLI's --version text is hard-coded to 1.0.0; use npm ls @tagna/udiot to identify the installed package version. See the CLI guide before generating files.

CI installation

Commit package-lock.json, then use npm ci on a compatible Node runtime. Public installation needs no publishing token:

- uses: actions/setup-node@v4
  with:
    node-version: '22.17.0'
    registry-url: 'https://registry.npmjs.org'
- run: npm ci
- run: npx tsc -p tsconfig.json

Troubleshooting

  • 401/404: check npm config get registry and npm config get @tagna:registry; confirm the requested version exists. An old GitHub Packages scope mapping can intercept otherwise public installs.
  • ERR_PACKAGE_PATH_NOT_EXPORTED: use an entry in the public export map; files existing under dist/ do not make them public imports.
  • TypeScript cannot resolve a subpath: use NodeNext or Bundler module resolution, and check the installed version.
  • Unsupported engine: upgrade Node; the RC minimum is 22.17.0.

Read the support and stability contract before deployment. Publishing is a maintainer workflow, documented separately in the publishing runbook.

From the canonical UDIOT public documentation.Try it in the playground ↗