rayfin: Instructions file for GitHub Copilot

Rayfin CLI Package Instructions

This document provides guidance for developing and testing the Rayfin CLI package (@microsoft/rayfin-cli).

Package Overview

The Rayfin CLI is the command-line interface for the Rayfin platform, providing tools for project initialization, development, and deployment operations.

Location: packages/tools/cli/

Key Commands:

• rayfin init - Initialize a new Rayfin project
• rayfin dev - Development server and local operations (requires RAYFIN_FEATURE_FLAGS=docker-local-dev; includes db, storage, watch subcommands)
• rayfin up - Deploy to cloud services (includes db, storage subcommands)
• rayfin docs - Query version-locked docs from Rayfin packages installed in the current project
• rayfin init ai-files install - Install or refresh Rayfin agent files (AGENTS.md, .mcp.json, .agents/skills/)
• rayfin init ai-files status - Report managed Rayfin agent-file state

Assets Folder and Template System

Assets Directory Structure

The CLI uses an assets folder for template files and static resources:

packages/tools/cli/
├── assets/
│   ├── .gitignore.template          # Git ignore template
│   ├── docker-compose.yml           # Docker compose configuration
│   └── agent-files/                 # AGENTS.md, .mcp.json entry, and Rayfin skill assets
├── src/
│   └── commands/
│       └── init.ts                  # Contains template loading logic
└── dist/                            # Compiled output

Template File Conventions

File Naming:

• Use .template extension for template files (e.g., .gitignore.template)
• Use descriptive names that match their target files
• For files without extensions, use the full filename (e.g., docker-compose.yml)

Template Loading Pattern:

async function createContentFromTemplate(): Promise<string> {
  const assetsDir = resolve(__dirname, '..', '..', 'assets');
  const templatePath = join(assetsDir, 'template-file.template');

  try {
    const templateContent = await readFile(templatePath, 'utf8');
    return templateContent;
  } catch (error) {
    console.warn(
      '⚠️  Warning: Could not read template, using fallback content'
    );
    // Provide minimal fallback content
    return 'fallback content';
  }
}