Getting Started

Overview

@growae/reactive-cli is a CLI tool for generating type-safe code from Sophia contract source files. It reads your contracts and produces TypeScript ACI definitions, typed actions, and hooks that integrate with Reactive.

Quick Start

1. Install

npm

npm install -D @growae/reactive-cli

yarn

yarn add -D @growae/reactive-cli

pnpm

pnpm add -D @growae/reactive-cli

2. Initialize Config

npx reactive init

This creates a reactive.config.ts file:

import { defineConfig } from '@growae/reactive-cli'

export default defineConfig({
  out: 'src/generated.ts',
  contracts: [
    {
      name: 'Token',
      source: 'contracts/Token.aes',
    },
  ],
})

3. Generate Code

npx reactive generate

This compiles your Sophia contracts and generates typed ACI, actions, and hooks.

4. Use Generated Code

import { tokenAci, tokenBytecode } from './generated'
import { readContract } from '@growae/reactive/actions'

const balance = await readContract(config, {
  address: 'ct_token...',
  aci: tokenAci,
  fn: 'balance',
  args: ['ak_owner...'],
})

Next Steps

• Installation — detailed install guide
• init command — config initialization
• generate command — code generation
• create-reactive — project scaffolder