Deriv Backoffice Template AI CLI

CLI tool for installing the Deriv Backoffice Template to your project.

Installation

Install the CLI globally:

npm install -g @deriv-com/backoffice-template-cli

Quick Start

1. Install the Template

Navigate to your project directory (or create a new one) and run:

deriv-bo install

Or use the short form:

deriv-bo i

This will:

• Copy all template files to your current directory
• Auto-detect your package manager (npm, pnpm, or yarn)
• Install all dependencies using your preferred package manager
• Set up the project structure

2. Configure Environment Variables

The installer automatically creates .env.local from .env.example. Update it with your values:

Required variables:

• VITE_API_BASE_URL - Your API endpoint
• VITE_OKTA_ISSUER - Okta issuer URL
• VITE_BO_HUB_OKTA_CLIENT_ID - Okta client ID
• VITE_BO_HUB_BASE_URL - Hub base URL

Note: The app will start with default placeholder values if env vars are not set, showing a warning in the console.

3. Start Development

After installation, start the development server:

npm run dev
# or
pnpm run dev
# or
yarn dev

Working with Tasks

The template includes an AI-assisted workflow for managing development tasks. After installing the template, you can use AI commands to create and manage tasks.

Creating a New Task

Use the @create-task command in your AI assistant to create a new development task:

@create-task

The AI will guide you through:

1. Setting up the app (installing shadcn/ui components)
2. Naming your task
3. Creating requirements
4. Collecting design assets (optional)
5. Generating implementation prompts
6. Starting the task

Starting a Task

To start working on an existing or pending task, use the @start-task command:

@start-task

The AI will:

1. Show you available tasks from today's date
2. Let you select a task to work on
3. Load the task context and requirements
4. Begin implementation following all coding standards

Available Commands

• deriv-bo install / deriv-bo i - Install template to current directory
• deriv-bo --version / deriv-bo -v - Show CLI version

What Gets Installed

The template includes:

• ✅ Vite + React 19 setup
• ✅ TypeScript configuration
• ✅ Tailwind CSS v4 with theme system
• ✅ shadcn/ui component library
• ✅ Okta authentication setup
• ✅ Environment configuration (.env.example)
• ✅ AI workflow blueprints and guidelines
• ✅ Testing setup and standards
• ✅ Coding standards and architecture docs
• ✅ Theme configuration system

Next Steps

After installation:

1. Configure environment: Copy .env.example to .env.local and fill in your values
2. Customize your theme: Edit src/config/theme.ts to match your brand colors, typography, and spacing
3. Create your first task: Use @create-task in your AI assistant
4. Start developing: Use @start-task to begin working on tasks

Need Help?

• Check the blueprints/ folder for detailed documentation
• Review ai-workflow/ for AI-assisted development workflows
• See the main project README for more information