@backtest-kit/sidekick 0.0.1

package/README.md

@@ -0,0 +1,64 @@
+# 🧿 @backtest-kit/sidekick
+
+> The easiest way to create a new Backtest Kit trading bot project. Like create-react-app, but for algorithmic trading.
+
+![bots](https://raw.githubusercontent.com/tripolskypetr/backtest-kit/HEAD/assets/bots.png)
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tripolskypetr/backtest-kit)
+[![npm](https://img.shields.io/npm/v/@backtest-kit/sidekick.svg?style=flat-square)](https://npmjs.org/package/@backtest-kit/sidekick)
+[![License](https://img.shields.io/npm/l/@backtest-kit/sidekick.svg)](https://github.com/tripolskypetr/backtest-kit/blob/master/LICENSE)
+
+Create production-ready trading bots in seconds with pre-configured templates, LLM integration, and technical analysis.
+
+📚 **[Backtest Kit Docs](https://backtest-kit.github.io/documents/example_02_first_backtest.html)** | 🌟 **[GitHub](https://github.com/tripolskypetr/backtest-kit)**
+
+## ✨ Features
+
+- 🚀 **Zero Config**: Get started with one command - no setup required
+- 📦 **Complete Template**: Includes backtest strategy, risk management, and LLM integration
+- 🤖 **AI-Powered**: Pre-configured with DeepSeek, Claude, and GPT-5 fallback chain
+- 📊 **Technical Analysis**: Built-in 50+ indicators via @backtest-kit/signals
+- 🔑 **Environment Setup**: Auto-generated .env with all API key placeholders
+- 📝 **Best Practices**: Production-ready code structure with examples
+
+## 🚀 Quick Start
+
+### Create a New Project
+
+```bash
+npx -y @backtest-kit/sidekick my-trading-bot
+cd my-trading-bot
+npm start
+```
+
+That's it! You now have a working trading bot with:
+- Complete backtest setup
+- LLM-powered strategy
+- Multi-timeframe technical analysis
+- Risk management validation
+- Environment configuration
+
+## 💡 CLI Options
+
+```bash
+# Create project with custom name
+npx -y @backtest-kit/sidekick my-bot
+
+# Create in current directory (must be empty)
+npx -y @backtest-kit/sidekick .
+```
+
+## 🔗 Links
+
+- [Backtest Kit Documentation](https://backtest-kit.github.io/documents/example_02_first_backtest.html)
+- [GitHub Repository](https://github.com/tripolskypetr/backtest-kit)
+- [Demo Projects](https://github.com/tripolskypetr/backtest-kit/tree/master/demo)
+- [API Reference](https://backtest-kit.github.io/documents/example_02_first_backtest.html)
+
+## 🤝 Contribute
+
+Found a bug or want to add a feature? [Open an issue](https://github.com/tripolskypetr/backtest-kit/issues) or submit a PR!
+
+## 📜 License
+
+MIT © [tripolskypetr](https://github.com/tripolskypetr)

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@backtest-kit/sidekick",
+  "version": "0.0.1",
+  "description": "The easiest way to create a new Backtest Kit trading bot project. Like create-react-app, but for algorithmic trading with LLM integration and technical analysis.",
+  "author": {
+    "name": "Petr Tripolsky",
+    "email": "tripolskypetr@gmail.com",
+    "url": "https://github.com/tripolskypetr"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "http://paypal.me/tripolskypetr"
+  },
+  "license": "MIT",
+  "homepage": "https://backtest-kit.github.io/documents/example_02_first_backtest.html",
+  "keywords": [
+    "create-backtest-app",
+    "backtest-kit",
+    "scaffolding",
+    "generator",
+    "cli",
+    "trading-bot",
+    "algorithmic-trading",
+    "backtesting",
+    "llm",
+    "ai-trading",
+    "technical-analysis",
+    "crypto",
+    "forex",
+    "quantitative-trading",
+    "template",
+    "boilerplate",
+    "starter-kit",
+    "npx"
+  ],
+  "files": [
+    "src",
+    "scripts",
+    "template",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tripolskypetr/backtest-kit",
+    "documentation": "https://github.com/tripolskypetr/backtest-kit/tree/master/docs"
+  },
+  "bugs": {
+    "url": "https://github.com/tripolskypetr/backtest-kit/issues"
+  },
+  "main": "./src/index.mjs",
+  "scripts": {
+    "start": "node ./src/index.mjs"
+  },
+  "bin": {
+    "@backtest-kit/sidekick": "./scripts/init.mjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "dependencies": {
+    "glob": "^11.0.1",
+    "log-symbols": "^7.0.0",
+    "mustache": "^4.2.0",
+    "picocolors": "^1.1.1"
+  }
+}
+ 

package/scripts/init.mjs

@@ -0,0 +1,250 @@
+#!/usr/bin/env node
+
+import { promises as fs } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { spawn } from 'child_process';
+import pc from 'picocolors';
+import { glob } from 'glob';
+import Mustache from 'mustache';
+import logSymbols from 'log-symbols';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const log = {
+  info: (msg) => console.log(`${pc.cyan(logSymbols.info)} ${msg}`),
+  success: (msg) => console.log(`${pc.green(logSymbols.success)} ${msg}`),
+  error: (msg) => console.log(`${pc.red(logSymbols.error)} ${msg}`),
+  warn: (msg) => console.log(`${pc.yellow(logSymbols.warning)} ${msg}`),
+};
+
+/**
+ * Copy files using glob patterns
+ */
+async function copyFiles(srcDir, destDir, pattern = '**/*') {
+  await fs.mkdir(destDir, { recursive: true });
+
+  const files = await glob(pattern, {
+    cwd: srcDir,
+    nodir: true,
+    dot: true,
+    absolute: false,
+  });
+
+  for (const file of files) {
+    const srcPath = path.join(srcDir, file);
+    const destPath = path.join(destDir, file);
+
+    // Create destination directory if needed
+    await fs.mkdir(path.dirname(destPath), { recursive: true });
+
+    // Copy file
+    await fs.copyFile(srcPath, destPath);
+
+    // Log copied file
+    console.log(`  ${pc.dim('→')} ${file}`);
+  }
+}
+
+/**
+ * Check if directory exists and is empty
+ */
+async function isDirEmpty(dirPath) {
+  try {
+    const files = await fs.readdir(dirPath);
+    return files.length === 0;
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      return true; // Directory doesn't exist, treat as empty
+    }
+    throw error;
+  }
+}
+
+/**
+ * Run npm install
+ */
+function runNpmInstall(projectPath) {
+  return new Promise((resolve, reject) => {
+    log.info('Installing dependencies...');
+
+    const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
+    const install = spawn(npm, ['install'], {
+      cwd: projectPath,
+      stdio: 'inherit',
+      shell: true,
+    });
+
+    install.on('close', (code) => {
+      if (code !== 0) {
+        reject(new Error(`npm install exited with code ${code}`));
+        return;
+      }
+      resolve();
+    });
+
+    install.on('error', reject);
+  });
+}
+
+/**
+ * Load and render template file
+ */
+async function renderTemplate(templatePath, data) {
+  const template = await fs.readFile(templatePath, 'utf-8');
+  return Mustache.render(template, data);
+}
+
+/**
+ * Main function
+ */
+async function main() {
+  console.log();
+  console.log(`${pc.bold(pc.blue('🧿 Backtest Kit'))}`);
+  console.log();
+
+  // Get project name from arguments
+  const args = process.argv.slice(2);
+  const projectName = args[0] || 'my-backtest-project';
+
+  const projectPath = path.resolve(process.cwd(), projectName);
+  const srcTemplatePath = path.resolve(__dirname, '..', 'src');
+  const templateDir = path.resolve(__dirname, '..', 'template');
+
+  // Template data for Mustache
+  const templateData = {
+    PROJECT_NAME: projectName,
+  };
+
+  try {
+    // Check if directory exists and is not empty
+    {
+      const isEmpty = await isDirEmpty(projectPath);
+      if (!isEmpty) {
+        log.error(`Directory ${projectName} already exists and is not empty.`);
+        process.exit(1);
+      }
+    }
+
+    {
+      log.info(`Creating a new Backtest Kit project in ${pc.bold(projectPath)}`);
+      console.log();
+    }
+
+    // Create project directory
+    {
+      await fs.mkdir(projectPath, { recursive: true });
+      log.success('Created project directory');
+    }
+
+    // Copy source template files using glob
+    {
+      log.info('Copying template files...');
+      await copyFiles(srcTemplatePath, path.join(projectPath, 'src'));
+      log.success('Copied template files');
+    }
+
+    // Create package.json from template
+    {
+      log.info('Creating package.json...');
+      const packageJsonContent = await renderTemplate(
+        path.join(templateDir, 'package.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'package.json'),
+        packageJsonContent,
+        'utf-8'
+      );
+      log.success('Created package.json');
+    }
+
+    // Create .env files from template
+    {
+      log.info('Creating .env template...');
+      const envContent = await renderTemplate(
+        path.join(templateDir, 'env.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, '.env.example'),
+        envContent,
+        'utf-8'
+      );
+      await fs.writeFile(
+        path.join(projectPath, '.env'),
+        envContent,
+        'utf-8'
+      );
+      log.success('Created .env files');
+    }
+
+    // Create .gitignore from template
+    {
+      log.info('Creating .gitignore...');
+      const gitignoreContent = await renderTemplate(
+        path.join(templateDir, 'gitignore.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, '.gitignore'),
+        gitignoreContent,
+        'utf-8'
+      );
+      log.success('Created .gitignore');
+    }
+
+    // Create README.md from template
+    {
+      log.info('Creating README.md...');
+      const readmeContent = await renderTemplate(
+        path.join(templateDir, 'README.mustache'),
+        templateData
+      );
+      await fs.writeFile(
+        path.join(projectPath, 'README.md'),
+        readmeContent,
+        'utf-8'
+      );
+      log.success('Created README.md');
+      console.log();
+    }
+
+    // Install dependencies
+    {
+      await runNpmInstall(projectPath);
+      console.log();
+      log.success('Installation complete!');
+      console.log();
+    }
+
+    // Display success message with instructions
+    {
+      console.log(`${pc.bold('Success!')} Created ${pc.cyan(projectName)} at ${pc.bold(projectPath)}`);
+      console.log();
+      console.log('Inside that directory, you can run several commands:');
+      console.log();
+      console.log(`  ${pc.cyan('npm start')}`);
+      console.log('    Starts the trading bot.');
+      console.log();
+      console.log('We suggest that you begin by typing:');
+      console.log();
+      console.log(`  ${pc.cyan(`cd ${projectName}`)}`);
+      console.log(`  ${pc.cyan('npm start')}`);
+      console.log();
+      console.log(`${pc.yellow('Don\'t forget to configure your API keys in .env file!')}`);
+      console.log();
+      console.log('Happy trading! 🚀');
+      console.log();
+    }
+
+  } catch (error) {
+    log.error('Failed to create project:');
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+// Run the script
+main().catch(console.error);

package/src/index.mjs

@@ -0,0 +1 @@
+export const foo = "bar";

package/template/README.mustache

@@ -0,0 +1,49 @@
+# {{PROJECT_NAME}}
+
+A trading bot project powered by [Backtest Kit](https://github.com/tripolskypetr/backtest-kit).
+
+## 🚀 Getting Started
+
+### Configure API Keys
+
+Edit `.env` file and add your API keys:
+
+```bash
+# For live trading
+CC_BINANCE_API_KEY=your_api_key_here
+CC_BINANCE_API_SECRET=your_api_secret_here
+
+# For AI strategies
+CC_OPENAI_API_KEY=your_openai_key_here
+```
+
+### Run the Bot
+
+```bash
+npm start
+```
+
+## 📚 Documentation
+
+- [Backtest Kit Docs](https://backtest-kit.github.io/documents/example_02_first_backtest.html)
+- [GitHub Repository](https://github.com/tripolskypetr/backtest-kit)
+
+## 📁 Project Structure
+
+```
+{{PROJECT_NAME}}/
+├── src/
+│   ├── index.mjs          # Main entry point
+│   └── utils/             # Utility functions
+├── .env                   # Environment variables
+├── .gitignore             # Git ignore rules
+└── package.json           # Dependencies
+```
+
+## 🤝 Contributing
+
+Feel free to submit issues and pull requests!
+
+## 📜 License
+
+MIT

package/template/env.mustache

@@ -0,0 +1,18 @@
+# Exchange API Keys (for live trading)
+# CC_BINANCE_API_KEY=your_api_key_here
+# CC_BINANCE_API_SECRET=your_api_secret_here
+
+# LLM API Keys (for AI strategies)
+# CC_OPENAI_API_KEY=your_openai_key_here
+# CC_ANTHROPIC_API_KEY=your_anthropic_key_here
+# CC_DEEPSEEK_API_KEY=your_deepseek_key_here
+# CC_GROK_API_KEY=your_grok_key_here
+
+# Ollama Configuration
+# CC_OLLAMA_API_KEY=your_ollama_key_here
+# CC_OLLAMA_BASE_URL=https://cloud.ollama.com
+
+# Trading Configuration
+# CC_PERCENT_SLIPPAGE=0.1
+# CC_PERCENT_FEE=0.1
+# CC_SCHEDULE_AWAIT_MINUTES=120

package/template/gitignore.mustache

@@ -0,0 +1,29 @@
+# Dependencies
+node_modules
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+tmp
+generated
+dump
+wwwroot
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE
+.vscode
+.idea
+*.swp
+*.swo
+*~

package/template/package.mustache

@@ -0,0 +1,36 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "description": "Backtest Kit trading bot project",
+  "scripts": {
+    "start": "node ./src/index.mjs",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "backtest-kit": "^1.11.10",
+    "@backtest-kit/signals": "^0.0.1",
+    "@backtest-kit/ollama": "^0.0.1",
+    "agent-swarm-kit": "^1.1.180",
+    "ccxt": "^4.4.41",
+    "uuid": "^11.0.3",
+    "dotenv": "^16.4.7",
+    "ollama": "^0.6.0",
+    "openai": "^4.97.0",
+    "jsonrepair": "^3.12.0",
+    "@langchain/core": "^0.3.57",
+    "@langchain/xai": "^0.0.2",
+    "@huggingface/inference": "^4.7.1",
+    "sanitize-html": "^2.17.0"
+  },
+  "devDependencies": {
+    "dotenv-cli": "^7.4.2"
+  },
+  "keywords": [
+    "backtest",
+    "trading",
+    "crypto",
+    "bot"
+  ]
+}