Welcome
CLI Tools Part 1: Project Setup.mdx
All Articles
articles/cli-tools-part-1:-project-setu
◈ Part 1/2 in Building CLI Tools with Node.js

CLI Tools Part 1: Project Setup

// Setting up a Node.js CLI project with TypeScript.

| articles

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Prerequisites

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.

  • Node.js 18+
  • npm or pnpm
  • Basic TypeScript knowledge

Project Initialization

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore.

mkdir my-cli
cd my-cli
npm init -y

TypeScript Configuration

Excepteur sint occaecat cupidatat non proident.

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "outDir": "dist"
  }
}

Package.json Setup

Lorem ipsum dolor sit amet.

Bin Field

Sed do eiusmod tempor incididunt ut labore.

{
  "bin": {
    "my-cli": "./dist/index.js"
  }
}

Next Steps

Continue to Part 2 for argument parsing.

→ Next in series

Part 2: CLI Tools Part 2: Argument Parsing