https://github.com/npm/wombat-cli
The wombat cli tool.
https://github.com/npm/wombat-cli
Last synced: 10 months ago
JSON representation
The wombat cli tool.
- Host: GitHub
- URL: https://github.com/npm/wombat-cli
- Owner: npm
- License: isc
- Archived: true
- Created: 2016-04-01T18:56:42.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-14T18:07:59.000Z (about 8 years ago)
- Last Synced: 2025-01-16T13:19:04.407Z (over 1 year ago)
- Language: JavaScript
- Size: 174 KB
- Stars: 35
- Watchers: 18
- Forks: 12
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wombat-cli
[](https://travis-ci.org/npm/wombat-cli) [](https://coveralls.io/github/npm/wombat-cli?branch=master)
The wombat cli tool.
,.--""""--.._
." .' `-.
; ; ;
' ; )
/ ' . ;
/ ; `. `;
,.' : . : )
;|\' : `./|) \ ;/
;| \" -,- "-./ |; ).;
/\/ \/ );
: \ ;
: _ _ ; )
`. \;\ /;/ ; /
! : : ,/ ;
(`. : _ : ,/"" ;
\\\`"^" ` : ;
( )
////
```
the helpful wombat tool
Commands:
hook control your hooks
package see information about the named package
versions see all available versions for the named package
whoami the username you are authenticated as
Options:
--registry, -r the registry configuration to use [default: "default"]
--json, -j print output as json [boolean] [default: false]
--help Show help [boolean]
--version show version information [boolean]
```
Help is available for each of the supported commands.
You may also do fun things like `wombat ls --depth=0` and `npm` will be invoked.
## configuration
Wombat reads its config from the file `~/.wombatrc`. This file is parsed as [TOML](https://github.com/toml-lang/toml). The defaults look like this:
```toml
[default]
registry = "https://registry.npmjs.org"
api = "https://registry.npmjs.org/-/npm"
```
You can add sections for other registries to talk to and point wombat to them using the name of the config section, or change the default to a registry you use more often. For example:
```toml
[default]
registry = "https://registry.npmjs.org"
api = "https://registry.npmjs.org/-/npm"
[enterprise]
registry = "https://npm-enterprise.private.npmjs.com"
api = "https://api.private.npmjs.com"
```
Then run something like `wombat -r enterprise package @secret/private-package`
## web hooks
```
wombat hook
Commands:
ls [pkg] list your hooks
add add a hook to the named package
update [secret] update an existing hook
rm remove a hook
Examples:
wombat hook add lodash https://example.com/webhook my-shared-secret
wombat hook ls lodash
wombat hook ls --json
wombat hook rm id-ers83f
```
## viewing packages
`wombat package yargs` shows you a formatted description of the package meta-data. Pass `--readme` to get the package readme rendered in your terminal as markdown!
`wombat versions yargs` shows you a list of all dist-tags and versions for the named package (in this case, yargs).
## whoami
Find out who you are logged in as for the registry you're using.
## License
ISC