Installation

TokiForge v1.0.0

Prerequisites

• Node.js 18+
• npm, yarn, or pnpm

Package Installation

Core Package

The core package is required for all TokiForge functionality:

npm install @tokiforge/core@^1.0.0

Framework Adapters

Install the adapter for your framework:

React

npm install @tokiforge/react@^1.0.0

Requires React 16.8+ (hooks support).

Vue

npm install @tokiforge/vue@^1.0.0

Requires Vue 3.0+.

Svelte

npm install @tokiforge/svelte@^1.0.0

Requires Svelte 3.0+.

Angular

npm install @tokiforge/angular@^1.0.0

Requires Angular 17.0+.

CLI Tool

Install globally for easy access:

npm install -g tokiforge-cli@^1.0.0

Or use with npx:

npx tokiforge-cli@^1.0.0 init

TypeScript Support

TokiForge is built with TypeScript and includes full type definitions. No additional @types packages needed!

CDN Usage

For vanilla JavaScript projects, you can use the core package via CDN:

<script type="module">
  import { ThemeRuntime } from 'https://cdn.jsdelivr.net/npm/@tokiforge/core@1.0.0/dist/index.mjs';
  
  const runtime = new ThemeRuntime({
    themes: [{ name: 'default', tokens: myTokens }],
  });
  
  runtime.init();
</script>

Framework-Specific Setup

React

import { ThemeProvider } from '@tokiforge/react';

// Wrap your app
function App() {
  return (
    <ThemeProvider config={themeConfig}>
      <YourApp />
    </ThemeProvider>
  );
}

Vue

<script setup>
import { provideTheme } from '@tokiforge/vue';

provideTheme(themeConfig);
</script>

Svelte

<script>
import { createThemeStore } from '@tokiforge/svelte';

const themeStore = createThemeStore(themeConfig);
</script>

Verification

After installation, verify it's working:

# Check CLI
TokiForge --version

# Or test in your code
import { TokenParser } from '@tokiforge/core';
console.log('TokiForge loaded!');

Troubleshooting

Module Not Found

If you get module not found errors:

1. Make sure you've installed the package: npm install @tokiforge/core
2. Check your Node.js version: node --version (should be 18+)
3. Try clearing cache: npm cache clean --force

TypeScript Errors

If TypeScript can't find types:

1. Ensure you're using TypeScript 5.0+
2. Check your tsconfig.json includes node_modules
3. Restart your TypeScript server

Build Errors

If you encounter build errors:

1. Make sure all dependencies are installed
2. Check that you're using compatible versions
3. See the Troubleshooting Guide for more help