inkathoninkathon

Command Cheat Sheet

Comprehensive list of commands for the perfect development workflow for inkathon projects

Project Setup

CommandDescription
npx create-inkathon-app@latestCreate new inkathon project

Global Commands

Execute from the project root:

CommandDescriptionCategory
bun run devStart frontend development serverDevelopment
bun run nodeRun local ink-nodeDevelopment
bun run dev-and-nodeRun frontend and node concurrentlyDevelopment
bun run codegenGenerate TypeScript types from contractsProduction
bun run buildBuild production frontend with codegenProduction
bun run build:standaloneBuild self-hosted production frontendProduction
bun run startStart production serverProduction
bun run lintRun linter checks across all workspacesCode Quality
bun run lint:fixAuto-fix linting issues in all workspacesCode Quality
bun run typecheckTypeScript type checking for all workspacesCode Quality
bun run cleanRemove build artifacts from all workspacesMaintenance
bun run clean-installRemove all node_modules and reinstallMaintenance
bun run updateInteractive dependency updatesMaintenance

Frontend Commands

Execute from /frontend directory or from root with bun run -F frontend <command>:

CommandDescriptionCategory
bun run devStart Next.js dev server with TurboDevelopment
bun run buildBuild for production with TurboProduction
bun run build:standaloneBuild self-hosted production buildProduction
bun run startStart production serverProduction
bun run lintRun Biome & Prettier checksCode Quality
bun run lint:fixAuto-fix Biome & Prettier issuesCode Quality
bun run typecheckTypeScript type checkingCode Quality
bun run cleanRemove .next and build artifactsMaintenance

Contract Commands

Execute from /contracts directory or from root with bun run -F contracts <command>:

CommandDescriptionCategory
bun run nodeStart local ink-node with dev chainDevelopment
bun run buildBuild all contracts in /srcBuild
bun run testRun unit tests for all contractsTesting
bun run codegenGenerate TypeScript types with PapiBuild
bun run deployDeploy on local dev chain (default)Deployment
CHAIN=<chain> bun run deployDeploy contract on <chain>Deployment
ACCOUNT_URI=<seed> bun run deployDeploy contract with <seed>Deployment
bun run lintRun Biome & Prettier checksCode Quality
bun run lint:fixAuto-fix Biome & Prettier issuesCode Quality
bun run typecheckTypeScript type checkingCode Quality
bun run cleanRemove target and build artifactsMaintenance