Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jbuck94 committed Jan 29, 2022
1 parent 943f355 commit 83f7726
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 521 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# pk-cli

A quick cli to view any property in your `package.json` file.

---

**To install, run:**

`npm i -g @jbuck94/pk-cli`

**To see all available commands, run:**

`pk --help` or `pk -h`

```
Usage: pk [options] [command]
Options:
-h, --help display help for command
Commands:
name View the name field in your package.json
version View the version field in your package.json
description View the description field in your package.json
repository View the repository field in your package.json
main View the main field in your package.json
scripts View the scripts field in your package.json
keywords View the keywords field in your package.json
author View the author field in your package.json
license View the license field in your package.json
dependencies View the dependencies field in your package.json
bin View the bin field in your package.json
help [command] display help for command
```
Loading

0 comments on commit 83f7726

Please sign in to comment.