Get Started

AI Scaffolding is a powerful CLI tool for creating projects from scratch with your preferred technology stack. It supports popular frameworks including Hardhat, Vite, NextJs, and more.

This guide will help you get started using the tool to bootstrap your next project.

Quick Start

Using package manager

There are two ways to get started. The quickest way is to run the package directly using the package manager of your choice:

npm

npx @appliedblockchain/ai-scaffolding my-web3-project

This command will start the interactive CLI that guides you through setting up your project.

Run it in a folder where you want to create your project. A new folder will be created inside base folder with the name you provide. CLI will prompt the name if you don't provide it as an argument.

Using installed command

If you prefer, you can install AI Scaffolding globally and run it using the ai-scaffolding command:

npm

npm install -g @appliedblockchain/ai-scaffolding

Once installed, you can create a new project by running:

ai-scaffolding my-web3-app

This command will start the interactive CLI that guides you through setting up your project.

Run it in a folder where you want to create your project. A new folder will be created inside base folder with the name you provide. CLI will prompt the name if you don't provide it as an argument.

Prerequisites

Before using AI Scaffolding, you'll need:

Node.js version 20 or higher
A package manager (npm, yarn, or pnpm)
GitHub Personal Access Token with read:packages permission

Setting up GitHub Access

Create a GitHub Personal Access Token

Go to GitHub

Settings → Developer Settings → Personal Access Tokens → Tokens (classic)

and generate a new token with at least read:packages scope.

Export the token as an environment variable

export GITHUB_TOKEN=your_github_token

Make it permanent (optional)

To make the token permanent, add it to your shell profile:

bash

echo 'export GITHUB_TOKEN=your_github_token' >> ~/.bashrc

Configure package manager for GitHub Packages

For npm and pnpm, create or update your global .npmrc file in your home directory:

cat > ~/.npmrc << EOL
@appliedblockchain:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=\${GITHUB_TOKEN}
EOL

If you're using Yarn, you'll need to add a .yarnrc.yml file in your home directory:

cat > ~/.yarnrc.yml << EOL
npmScopes:
  appliedblockchain:
    npmRegistryServer: "https://npm.pkg.github.com"
    npmAlwaysAuth: true
    npmAuthToken: "\${GITHUB_TOKEN}"
EOL

These configurations tell your package manager where to find the @appliedblockchain packages and how to authenticate when downloading them.

Next Steps

Before creating your project, you might want to check out:

Overview - Overview of the packages and their configuration options
Cursor Rules - How to manage and configure Cursor rules for AI-assisted development