@almeida.cavalcante2/shan-greetings

shan-greetings

A simple CLI that displays our friend Shan's unique greetings.

Features

• List Shan's special greetings
• Generate random Shan-style greetings
• Colorful and friendly command line interface

Installation

There are two ways to install the CLI:

1. Via NPM (when published)

npm install -g shan-greetings

2. From source code

1. Clone the repository:

git clone https://github.com/your-username/shan-greetings.git
cd shan-greetings

2. Install dependencies:

npm install

3. Give execution permission to bin file:

chmod +x bin/greetings.js

4. Install globally:

npm install -g .

Usage

The CLI has two main commands:

List all available greetings

hi list

Get a random greeting

hi shan

Help

To see all available commands:

hi --help

Available Greetings

Current greetings include:

• "Hi how hello, everyone"
• "Hi how once again, hello everyone"

Development

To contribute to the project:

1. Fork the repository
2. Clone your fork:

git clone https://github.com/your-username/shan-greetings.git

3. Create a branch for your feature:

git checkout -b feature/new-feature

4. Make your changes and commit:

git commit -m "Add new feature"

5. Push to your fork:

git push origin feature/new-feature

6. Open a Pull Request

Troubleshooting

If the greetings command is not available after installation:

1. Check if npm's bin directory is in your PATH:

echo $PATH

2. If needed, add to your ~/.bashrc or ~/.zshrc:

export PATH="$PATH:$(npm config get prefix)/bin"

3. Reload your terminal:

source ~/.bashrc  # or source ~/.zshrc

License

MIT

Author

Your Nam