Rabbit is a simple yaml based tool for command line actions. It will read a rabbit.yaml configuration file from the current directory and provide a list available commands.
## Installation
You will need to have Python and Pip [installed](http://python-packaging-user-guide.readthedocs.org/en/latest/installing/#requirements-for-installing-packages) then run the following command in your cli.
$ pip install rabbit
## Usage
- Enter 'rabbit' or 'rab' in your command line
- Rabbit must be able to find a rabbit.yaml file in the current directory.
- 'rabbit --help' will display a list of all available rabbit commands
## Configuration
Rabbit will look for the closest rabbit.yaml file. This [yaml](http://docs.ansible.com/YAMLSyntax.html) file must contain a commands property. The commands property is a list of all commands to be proxied by rabbit. Simple as that!
```yaml
commands:
- hop: npm install
to: docker run -it --rm node npm install
description: Runs 'npm install' on the current directory
- hop: run node
to: echo "Run Node"
description: echos 'run node' to the command line
```
### Command
- A command's 'hop' property represents the rabbit command to be entered.
- A command's 'to' property defines the actual command to be run in terminal.
- All arguments provided after the rabbit 'hop' decleration will be appended to the proxied command.
- Commands that share a similar hop will be grouped for convinience.
### [Contributing](CONTRIBUTING.md)
Metadata
Release files for rabbit 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| rabbit-1.2.0.tar.gz | 11.5 kB | Without provenance | Details |
Release files / rabbit-1.2.0.tar.gz
| Download URL | rabbit-1.2.0.tar.gz |
|---|---|
| Size | 11.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0342278e3024971fbafa56094b5064443d90e932891450fcb49bad8f5f52d190
|
|
BLAKE2b-256 checksum How to use checksums |
b49ae6b9a20fadd131d48bde8d47226d39fb3b63dd1ed185e28f19b8f7de969c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for rabbit 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.