npm

Need private packages and team management tools?Check out npm Orgs. »

@itinerisltd/cognomen

0.2.0 • Public • Published

cognomen

oclif Version Downloads/week License Hire Itineris

Goal

Generate WP CLI aliases for Trellis projects.

Learn more on Running Commands Remotely - WP-CLI — WordPress.

Requirements

  • NodeJS v10 or later
  • WP CLI v2 or later
  • Ansible v2.7.4 or later

Installation

$ npx @itinerisltd/cognomen just works! No installation required.

Usage

$ cd /path/to/trellis
$ npx @itinerisltd/cognomen

Add these lines to <bedrock>/wp-cli.yml or <bedrock>/wp-cli.local.yml:

_:
  inherit: wp-cli.cognomen.yml
$ cd /path/to/bedrock
$ wp @staging cli info
$ wp @production cli info

Options

# Specific remote environments
$ npx @itinerisltd/cognomen --remotes=staging,testing,qa
 
# Specific local environment
$ npx @itinerisltd/cognomen --local=dev
 
$ npx @itinerisltd/cognomen --help
Generate WP CLI aliases for Trellis projects
 
USAGE
  $ cognomen
 
OPTIONS
  -h, --help             show CLI help
 
  -l, --local=local      (required) [default: development] local environment
                         name
 
  -r, --remotes=remotes  comma-separated list of remote environment names
 
  -v, --version          show CLI version

FAQ

Why should I use cognomen?

See: https://github.com/ItinerisLtd/cognomen/issues/3#issuecomment-456563138

Error: Alias '@xxx' not found.

Add these lines to <bedrock>/wp-cli.yml or <bedrock>/wp-cli.local.yml:

_:
  inherit: wp-cli.cognomen.yml

What if I have a multiple web server setup?

Only 1 alias is generated per enviroment even if you have a multiple web server setup. Under the hood, cogomen use anisble run_once option to achive that.

Can I change default flag values via environment variables?

Yes.

These 2 commands are equivalent:

$ npx @itinerisltd/cognomen --remotes=staging,testing,qa --local=dev
$ COGNOMEN_REMOTES=staging,testing,qa COGNOMEN_LOCAL=dev npx @itinerisltd/cognomen

Can I install cognomen instead of using $ npx?

Yes. However, you are responsible for updating it.

# yarn or npm doesn't matter
$ yarn global add @itinerisltd/cognomen
$ cognomen --remotes=staging,testing,qa --local=dev

Why don't you make an Ansible Galaxy role instead?

Because we have too many sites to maintain, adding/updating roles to all of our sites is tedious.

It looks awesome. Where can I find some more goodies like this?

This isn't on wp.org. Where can I give a ⭐️⭐️⭐️⭐️⭐️ review?

Thanks! Glad you like it. It's important to make my boss know somebody is using this project. Instead of giving reviews on wp.org, consider:

Feedback

Please provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.

Security

If you discover any security related issues, please email hello@itineris.co.uk instead of using the issue tracker.

Change log

Please see CHANGELOG for more information on what has changed recently.

Credits

cognomen is a Itineris Limited project created by Tang Rufus.

Full list of contributors can be found here.

License

cognomen is released under the MIT License.

install

npm i @itinerisltd/cognomen

Downloadsweekly downloads

1

version

0.2.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability