Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mskian/friendship-day-cli
Frnds - Happy Friendship Day CLI : ASCII Text Art Greeting Wishes.
https://github.com/mskian/friendship-day-cli
bash bash-cli cli command-line-tool commander commanderjs friends friendship friendship-day friendship-day-wishes greetings happy-friendship-day javascript typescript wishes
Last synced: 27 days ago
JSON representation
Frnds - Happy Friendship Day CLI : ASCII Text Art Greeting Wishes.
- Host: GitHub
- URL: https://github.com/mskian/friendship-day-cli
- Owner: mskian
- License: mit
- Created: 2024-07-16T06:55:52.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-10T03:53:17.000Z (about 1 month ago)
- Last Synced: 2024-10-12T18:26:50.457Z (about 1 month ago)
- Topics: bash, bash-cli, cli, command-line-tool, commander, commanderjs, friends, friendship, friendship-day, friendship-day-wishes, greetings, happy-friendship-day, javascript, typescript, wishes
- Language: Shell
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Friendship Day CLI
 
frnds - Happy Friendship Day CLI : ASCII Text Art Greeting Wishes.
> "frnds" : friends 🌟
Command Line Interface tool for Happy Friendship Day Wishes : Happy Friendship Day Wishes in Terminal/CMD and Termux.
## Built using
- Typescript
- ASCII Art
- ANSI Colors
- Emoji's
- Commander.js -
## Setup
- Clone or Download Repo
```sh
git clone https://github.com/mskian/friendship-day-cli.git
## Open Project Folder
cd friendship-day-cli
## install packages
pnpm install
## build CLI
pnpm build
```
- Link and Test the CLI Locally
```sh
npm link or pnpm link --global
```
- unlink CLI
```sh
npm rm --global frnds or pnpm uninstall --global frnds
```
- Access CLI Globally
```sh
frnds -h
```
- Access via `NPX`
```sh
npx frnds -h
```
- install via `NPM` and `PNPM`
```sh
## install via npm
npm install -g frnds
## Remove Package
npm uninstall -g frnds
## install via pnpm
pnpm install -g frnds
## update package
pnpm update -g frnds
## Remove Package
pnpm uninstall -g frnds
```
## CLI Usage
```sh
# For Help Message
frnds -h
# Generate Greeting Web page
frnds -n "Hello Friend"
# Random Quotes
frnds -q
# ASCII Text Art
frnds -a
# Custom Message
frnds -m "Happy Friendship Day"
```
## Bash CLI
Happy Friendship Day Bash CLI
```sh
## Set Permission
chmod +x friend.sh
# RUN CLI
./friend.sh -h
```
## MISC (Development)
- Clear NPX and PNPM Cache
```sh
npx clear-npx-cache
pnpm store prune
```
## Contributing 🙌
Your PR's are Welcome
## LICENSE
MIT