Skip to content

bot-cli

BOT Chain CLI

The fastest way to scaffold, connect, and ship dApps on BOT Chain.

npm version License: Apache 2.0 Node.js version GitHub Stars PRs Welcome


bot-cli is an interactive command-line tool that bootstraps BOT Chain projects in seconds. Choose your frontend framework, contract starter, and tooling preferences — the CLI scaffolds everything with best practices baked in.

Why BOT Chain? BOT Chain is a fast, EVM-compatible L1 built for builders. Pre-configured networks, RPCs, and wallet connections out of the box.


✨ Features

  • 🚀 Interactive scaffolding — answer a few prompts and get a full project
  • 🔌 Wallet ready — wagmi + RainbowKit pre-configured for BOT Testnet & Mainnet
  • 🧱 Contract starters — Counter & Guess the Number contracts with Foundry
  • 🎨 BOT-branded UI — every frontend template ships with a polished neobrutalist landing page
  • 🌗 Dark/light mode — theme toggle built in
  • 🔧 Contract playground — read/write contract functions from the UI
  • 📦 Multiple frontends — Next.js, Vite+React, Vite+Vue, Vite+Vanilla
  • 🛠 Package manager agnostic — npm, pnpm, yarn, or bun

📦 Quick Install

npm install -g @klips-tooling/bot-cli

Requires Node.js >= 18.


🏁 Quick Start

# 1. Create a new project (interactive)
bot-cli init

# 2. Navigate into your project
cd my-bot-dapp

# 3. Start the frontend
npm run dev        # or: pnpm dev / yarn dev / bun run dev

# 4. (Optional) Run smart contract tests
cd contracts
forge test

What you'll be prompted for

Prompt Options
Project name Any valid package name
Project type Fullstack dApp / Smart Contracts Only
Contract framework Foundry
Contract starter Counter / Guess the Number
Default network BOT Testnet / BOT Mainnet
Frontend template Next.js + React / Vite + React / Vite + Vue / Vite + Vanilla
Package manager npm / pnpm / Yarn / Bun
TypeScript Yes / No (frontend only)
Styling Plain CSS / Tailwind CSS
Initialize git Yes / No
Linting None / Prettier / ESLint + Prettier

📂 What gets scaffolded

my-bot-dapp/
├── contracts/           # Foundry project (Counter or GuessTheNumber)
│   ├── src/
│   ├── test/
│   ├── script/
│   └── foundry.toml
├── frontend/            # Your chosen frontend template
│   ├── src/
│   │   ├── botChain.ts          # Chain config (mainnet + testnet)
│   │   ├── App.tsx              # BOT-branded landing page
│   │   ├── components/
│   │   │   ├── ContractPlayground.tsx
│   │   │   └── ToastContainer.tsx
│   │   └── style.css            # Neobrutalist design system
│   ├── .env.example
│   └── package.json
└── README.md

🛠 CLI Commands

Command Description
bot-cli init Scaffold a new BOT Chain project
bot-cli add [feature] Add a contract starter (token, nft) to existing project
bot-cli compile Compile smart contracts (auto-detects Foundry or Hardhat)
bot-cli deploy Deploy smart contracts to BOT Chain (interactive guides & logs)
bot-cli clean Wipe build artifacts (out/, cache/, .next/, dist/)
bot-cli wallet Generate a throwaway dev keypair (address + private key) for testing
bot-cli config Read and write project .env configuration values
bot-cli testnet Testnet tools (faucet browser opener, RPC, MetaMask network configs)
bot-cli info Display BOT Chain network details (mainnet + testnet)
bot-cli templates List all available templates, frameworks, and starters
bot-cli --version Print the CLI version
bot-cli --help Show all available commands (with custom premium colored layout)

🌐 Networks

BOT Mainnet

BOT Testnet (Bohr)


🧑‍💻 Development

This is a pnpm + Turborepo monorepo.

# Clone
git clone https://github.com/klips-tooling/bot-cli.git
cd bot-cli

# Install
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

# Run the CLI locally
pnpm botdev init

Project structure

bot-cli/
├── packages/
│   └── cli/              # The bot-cli npm package
│       ├── src/
│       │   ├── commands/ # init, add, deploy, testnet, info
│       │   ├── utils/    # template, prompts, packageManager
│       │   ├── index.ts  # CLI entry point
│       │   └── constants.ts
│       ├── scripts/      # Build helpers
│       ├── test/         # Vitest tests
│       └── dist/         # Compiled output (+ templates)
├── templates/            # Template source files
│   ├── nextjs-react/
│   ├── vite-react/
│   ├── vite-vue/
│   ├── vite-vanilla/
│   ├── hardhat-basic/
│   └── contract-starters/
├── docs/                 # GitHub Pages landing page
├── plans/                # Internal planning docs
└── package.json          # Root workspace config

🤝 Contributing

We love contributions! See CONTRIBUTING.md for:

  • Dev environment setup
  • How to add new templates
  • Commit conventions
  • PR process

All contributions are licensed under Apache 2.0.


📄 License

This project is licensed under the Apache License, Version 2.0. See LICENSE for the full text.


🔗 Links


Made with ⚡ by Eldevode for the BOT Chain ecosystem

About

Interactive CLI for scaffolding fullstack dApps on BOT Chain — Next.js, React, Vue, Foundry, Hardhat, wagmi, and more.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages