My CLI Application

This project is a command-line interface (CLI) application developed using TypeScript. It provides a simple example of how to create and structure a CLI application.

Project Structure

my-cli-app
├── src
│   ├── index.ts          # Entry point of the CLI application
│   └── commands
│       └── hello.ts      # Command that outputs a greeting message
├── package.json           # npm configuration file
├── tsconfig.json          # TypeScript configuration file
└── README.md              # Documentation for the project

Installation

To set up the project, follow these steps:

1. Create the project directory:

   mkdir my-cli-app
   cd my-cli-app

2. Initialize a new npm project:

   npm init -y

3. Install TypeScript and any other necessary dependencies:

   npm install typescript @types/node --save-dev

4. Create the TypeScript configuration file:

   npx tsc --init

5. Set up the project structure:

   mkdir src
   mkdir src/commands
   touch src/index.ts
   touch src/commands/hello.ts
   touch README.md

6. Update tsconfig.json with appropriate settings:

   {
     "compilerOptions": {
       "outDir": "./dist",
       "rootDir": "./src"
     }
   }

7. Update package.json to include build and run scripts:

   {
     "scripts": {
       "build": "tsc",
       "start": "node dist/index.js"
     }
   }

Usage

1. Implement the CLI logic in src/index.ts and src/commands/hello.ts.

2. Build the project:

   npm run build

3. Run the CLI application:

   npm start

Contributing

Feel free to submit issues or pull requests for improvements or additional features.