derhasi / buddy
Command line tool for locating command line tools in a parent or project scope
Installs: 61
Dependents: 1
Suggesters: 0
Security: 0
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 5
Type:cli
Requires
- symfony/config: ^2.6.0
- symfony/console: ^2.6.0
- symfony/yaml: ^2.6.0
- webmozart/path-util: ^2.2.0
This package is not auto-updated.
Last update: 2024-10-26 18:49:21 UTC
README
A command line tool to help you execute a command in the direct location
Example commands
buddy composer
buddy drush
b drush # Alternate shortcut
Example .buddy.yml
For providing buddy command shortcuts, simply place a .buddy.yml
in the current
or any parent folder.
commands: # calls the global composer command from the root folder composer: cmd: composer workingDir: $DIR # Calls a local drush command in ./vendor/bin/drush drush: cmd: drush cmdDir: $DIR/vendor/bin workingDir: $DIR #defaults: # not implemented yet # uri: http://example.com # root: $DIR/docroot root: false
buddy
supports multiple config files, so commands from a parent folders will
get merged. Command shortcuts from subfolders take precedence over those of
parent folders with the same name.
Structure
commands
: This holds a list of command shortcuts. The key is the shortcut to use withbuddy
in the CLI.root
: If set totrue
, configuration files in parent folders will get ignored
Command options
cmd
(required): the actual cli command to callcmdDir
(optional): directory the command is located in. When the directory is not given, global commands can be executed.workingDir
(optional): Location from where to call the given command. Defaults to the current working directory.
Replacement patterns
Following replacement patterns can be used for replacing parts of a directory value:
$CWD
: Current working directory$DIR
: Directory of the .buddy.yml file hlding the command configuration
Installation
After installing composer you can install the command globally:
- Run
composer global require derhasi/buddy:dev-master
to install globally. - Make sure
~/.composer/vendor/bin
is part of your$PATH
, e.g. by addingexport PATH=~/.composer/vendor/bin:$PATH
to your.bashrc
or.profile
Support
Please post an issue in the issue queue in the case you need support or detect any errors. Pull requests are welcome too.