https://github.com/quiibz/shineboard-cli

The CLI for ShineBoard - A beautiful way to share code
https://github.com/quiibz/shineboard-cli

cli javascript utility-application

Last synced: 2 days ago
JSON representation

The CLI for ShineBoard - A beautiful way to share code

• Host: GitHub
• URL: https://github.com/quiibz/shineboard-cli
• Owner: QuiiBz
• License: apache-2.0
• Created: 2020-05-15T13:07:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-26T17:34:06.000Z (over 2 years ago)
• Last Synced: 2024-09-30T22:10:37.503Z (3 days ago)
• Topics: cli, javascript, utility-application
• Language: JavaScript
• Homepage:
• Size: 42 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


# ShineBoard CLI

## The CLI for ShineBoard - A Beautiful way to share code

ShineBoard is a open-source platform to make sharing code easier. Wasted by all the .txt files you downloaded and the poor hastebin codes ? Switch now to ShineBoard :

* Type `shine help` to get started

* To upload very quicly, run `shine add `

* You can also choose to specify a name for this paste with the flag `--name` (or `-n`) 

* If you which, you can force the language with `--language` (or `-l`)

* You may also set a password to protect the paste with `--password` (or `-p`)

Alternatively, you can use the [web application](https://github.com/ShineBoard/shineboard) to create paste from the web.

## Installing

With NPM :

* Run `npm install -g @shineboard/cli` in your terminal

With Yarn :

* Run `yarn global add @shineboard/cli` in your terminal

## Contributing

Since it's just a Node.js app, you may already know how to do this :

* Fork this repository, then clone it to your device

* Install JS dependencies with :

  * NPM : `npm install`

  * Yarn : `yarn`

* Run `node src/index.js` to try the CLI without linking it

* You can run `npm link` (or `yarn link`) to get the `shine` CLI running locally. Make sure to type `npm unlink` (or `yarn unlink`) to remove symlink created before. 

## License

ShineBoard CLI is licensed under the [Apache license](http://www.apache.org/licenses/LICENSE-2.0).