cli.md

Alias HQ CLI

Command line tool to generate configuration, rewrite source code, and debug plugins

Overview

The Alias HQ CLI is designed to make the configuration and refactoring your project as simple as picking some options, and hitting enter.

In the terminal, run the following code:

alias-hq

Choose from the available options:

• Configure paths - create or configure your project's path aliases
• Setup integrations - configure and debug integrations for Webpack, Jest, etc
• Update source code - refactor source code with your configured aliases

Troubleshooting

Running the CLI

If typing alias-hq does not run the CLI, you'll need to add node_modules/.bin to your system path.

Mac

Add the following line to ~/.bash_profile or equivalent (note: ~/.zshrc on the latest OSX!):

export PATH=./node_modules/.bin:$PATH

Windows

Follow the Instructions here.

Last resort

If you are unable to modify your system path, just call the CLI directly:

./node_modules/.bin/alias-hq

Clickable links

The following plugin enables clickable links in WebStorm (useful when updating source code):

• https://plugins.jetbrains.com/plugin/7677-awesome-console/

VS Code displays them by default.