Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xmukesh/snipli
✨ A command-line interface for quickly sharing code snippets of your local files
https://github.com/0xmukesh/snipli
cli gist oclif typescript
Last synced: 13 days ago
JSON representation
✨ A command-line interface for quickly sharing code snippets of your local files
- Host: GitHub
- URL: https://github.com/0xmukesh/snipli
- Owner: 0xMukesh
- License: mit
- Created: 2022-04-17T07:16:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-01T13:03:47.000Z (almost 2 years ago)
- Last Synced: 2024-12-15T17:11:58.831Z (18 days ago)
- Topics: cli, gist, oclif, typescript
- Language: TypeScript
- Homepage: https://www.snipli.xyz
- Size: 561 KB
- Stars: 147
- Watchers: 1
- Forks: 2
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🦄 snipli
✨ A command-line interface for quickly sharing code snippets for your local files
- [Usage](#usage)
- [Commands](#commands)
# Usage
```bash
$ npm install -g snipli
$ snipli COMMAND
Running command...
$ snipli (--version)
snipli/1.0.0 win32-x64 node-v16.13.0
$ snipli --help [COMMAND]
USAGE
$ snipli COMMAND
...
```
# Commands
- [`snipli create`](#snipli-create)
- [`snipli delete`](#snipli-delete)
- [`snipli edit`](#snipli-edit)
- [`snipli help [COMMAND]`](#snipli-help-command)
- [`snipli id`](#snipli-id)
- [`snipli login`](#snipli-login)
- [`snipli logout`](#snipli-logout)
- [`snipli read`](#snipli-read)
- [`snipli whoami`](#snipli-whoami)
## `snipli create`
🦄 Create a new snippet of your local file on gist.github.com
```
USAGE
$ snipli create -f -d [-p]
FLAGS
-d, --description= (required) Description of the gist
-f, --file= (required) Path to the file of which you want to create a gist
-p, --[no-]public Whether the gist should be public or not
DESCRIPTION
🦄 Create a new snippet of your local file on gist.github.com
EXAMPLES
$ snipli create --file=code.ts --description='Need help at line 59 of file code.ts' --public
```
## `snipli delete`
🚚 Delete a gist
```
USAGE
$ snipli delete -i
FLAGS
-i, --id= (required) ID of the gist which is to be deleted
DESCRIPTION
🚚 Delete a gist
EXAMPLES
$ snipli delete --id=bfce776b3ad1145f764d89c296fec605
```
## `snipli edit`
✏ Edit an existing gist
```
USAGE
$ snipli edit -i -f -d [-p]
FLAGS
-d, --description= (required) The description of the Gist
-f, --file= (required) The path of the file which has the edited content
-i, --id= (required) ID of the Gist which you are going to edit
-p, --[no-]public Whether the Gist is public or not
DESCRIPTION
✏ Edit an existing gist
EXAMPLES
$ snipli edit --id=ca22a324f761cd241ace4c9a35286496 --file=updated-code.ts --description='Updated the code' --public
```
## `snipli help [COMMAND]`
Display help for snipli.
```
USAGE
$ snipli help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for snipli.
```
## `snipli id`
💡 Get the ID of a gist from it's link
```
USAGE
$ snipli id -l
FLAGS
-l, --link= (required) Link of the gist
DESCRIPTION
💡 Get the ID of a gist from it's link
EXAMPLES
$ snipli id --link=https://gist.github.com/Kira272921/bfce776b3ad1145f764d89c296fec605
```
## `snipli login`
🔑 Login into snipli via GitHub
```
USAGE
$ snipli login
DESCRIPTION
🔑 Login into snipli via GitHub
EXAMPLES
$ snipli login
```
## `snipli logout`
📤 Logout from snipli
```
USAGE
$ snipli logout
DESCRIPTION
📤 Logout from snipli
EXAMPLES
$ snipli logout
```
## `snipli read`
📖 Read a gist locally using the configured editor
```
USAGE
$ snipli read -i
FLAGS
-i, --id= (required) ID of the Gist
DESCRIPTION
📖 Read a gist locally using the configured editor
EXAMPLES
$ snipli read --id=ca22a324f761cd241ace4c9a35286496
```
## `snipli whoami`
👀 Get the info about the logged in user
```
USAGE
$ snipli whoami
DESCRIPTION
👀 Get the info about the logged in user
EXAMPLES
$ snipli whoami
```
## Authors
### Mukesh
- Twitter: [@0xMukesh](https://twitter.com/0xMukesh)
### Avneesh Agarwal
- Website: https://www.avneesh.tech/
- Twitter: [@avneesh0612](https://twitter.com/avneesh0612)
- Github: [@avneesh0612](https://github.com/avneesh0612)
- LinkedIn: [@avneesh0612](https://www.linkedin.com/in/avneesh0612)