Generate WP CLI aliases for Trellis projects

Use https://github.com/roots/trellis-cli/pull/52 instead
Last updated 8 months ago by tangrufus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @itinerisltd/cognomen 
SYNC missed versions from official npm registry.

This project has been ported to roots/trellis-cli and been abandoned.

Use roots/trellis-cli instead and checkout similar tools by:


oclif Version Downloads/week License Hire Itineris


Generate WP CLI aliases for Trellis projects.

Learn more on:


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


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


$ 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


# 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

  $ cognomen

  -h, --help             show CLI help

  -l, --local=local      (required) [default: development] local environment

  -r, --remotes=remotes  comma-separated list of remote environment names

  -v, --version          show CLI version


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?


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:


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.


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.


cognomen is a Itineris Limited project created by Tang Rufus.

Full list of contributors can be found here.


cognomen is released under the MIT License.

Current Tags

  • 0.2.1                                ...           latest (8 months ago)

4 Versions

  • 0.2.1 [deprecated]           ...           8 months ago
  • 0.2.0 [deprecated]           ...           a year ago
  • 0.1.1 [deprecated]           ...           a year ago
  • 0.1.0 [deprecated]           ...           a year ago
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 4
Last Month 4
Dependencies (7)
Dev Dependencies (7)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |