This commit is contained in:
Arwid Thornström
2022-01-19 09:17:55 +01:00
parent 7f934532e9
commit 19b15a585c
8 changed files with 27 additions and 49 deletions
+10 -20
View File
@@ -1,25 +1,15 @@
# pwcli CLI
# Photowall CLI
A CLI for pwcli.
A CLI for Photowall, a platform for doing any type of commands or automation
needed for the photowall organisation.
## Customizing your CLI
# Installation
Check out the documentation at https://github.com/infinitered/gluegun/tree/master/docs.
1. Clone the repo to a local folder.
2. Build the project with `yarn build`
3. Connect a runnable command with `yarn link`
4. Open a new terminal window and run `pwcli`
## Publishing to NPM
To package your CLI up for NPM, do this:
```shell
$ npm login
$ npm whoami
$ npm lint
$ npm test
(if typescript, run `npm run build` here)
$ npm publish
```
# License
MIT - see LICENSE
# Usage
When running `pwcli` command in the terminal is will open a interactive view but all commands are accessable through shortcuts. So if you want to run status on development testservers its possible to run `pwcli d ts s` for d = development, ts = test servers, s = status. Shortcuts are listed in the interactive view.