https://github.com/parthiv-m/cli-parthiv
This is a Command Line Interface Portfolio built with Ink.
https://github.com/parthiv-m/cli-parthiv
cli cli-app ink-component npm-package npx react
Last synced: 2 months ago
JSON representation
This is a Command Line Interface Portfolio built with Ink.
- Host: GitHub
- URL: https://github.com/parthiv-m/cli-parthiv
- Owner: Parthiv-M
- Created: 2021-09-24T17:07:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T16:07:10.000Z (over 3 years ago)
- Last Synced: 2025-03-28T11:17:03.759Z (about 1 year ago)
- Topics: cli, cli-app, ink-component, npm-package, npx, react
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/cli-parthiv
- Size: 268 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cli-parthiv
This is a Command Line Interface Portfolio built with [Ink](https://www.npmjs.com/package/ink). This CLI Portfolio is available as an NPM package [here](https://www.npmjs.com/package/cli-parthiv).
# Prerequisites
- [NodeJS](https://nodejs.org/en/), a JavaScript run-time engine
- [NPM](https://www.npmjs.com/) above version `5.2.0`, a packet manager for Node
- Verify that npm is correctly installed by running `npm -v`
# Installing and viewing the portfolio
- Run the following command to install `cli-parthiv` on your system with `npm`
```bash
$ npm install --global cli-parthiv
```
- Run the CLI directly with `npx` by running
```bash
$ npx cli-parthiv
```
## Running the CLI
- Run the CLI with the `--help` option to see the options available
```
$ cli-parthiv --help
Usage
$ cli-parthiv
Options
--gradient gradient-name which can be mind, fruit, morning or passion. The default gradient is cristal.
Example
$ cli-parthiv --gradient=mind
```
- Or just run the CLI with `cli-parthiv` to see the portfolio with the default options
## Note
The CLI portfolio is best viewed on a terminal window size of (at least) `140 columns` by `40 rows`