README.md

Alias HQ

Alias HQ documentation

Get started

Start here if you are short on time:

• Quick start
  A bite-sized version of the full docs

• Integrations
  Snippets of setup code for Webpack, Jest, etc

CLI

The CLI provides an interactive prompt to make it easy to configure or refactor your project:

• Alias HQ CLI
  Run the CLI

• Configure paths
  Configure your project's path aliases

• Setup integrations
  Setup and debug libraries like Webpack, Jest, etc

• Update source code
  Refactor your source code with your shiny new aliases

API

The API allows you to query configured paths and use them in your target framework:

• API
  A simple guide on Alias HQ's simple API

• Plugins
  Detailed guide on writing path transforms and packaging them as plugins