Skip to main content

1. Installation

Getting started with lage is easy.

Quick installation​

For automated quick installation instructions, see the Quick Start guide.

Manual installation​

If you prefer having more control, you can install lage manually.

This example assumes that some or all of the packages in your workspace define build, test, and lint scripts in their package.json files. You can use any script names that are relevant for your repo instead.

1. Install lage at the root level​

In your workspace root package.json, add lage under devDependencies.

Feel free to replace latest tag with something specific. Take a look at the npm link for lage to see what the latest version may be at the time.

/package.json
jsonc
{
  "devDependencies": {
    // ...
    "lage": "latest"
    // ...
  }
}
/package.json
jsonc
{
  "devDependencies": {
    // ...
    "lage": "latest"
    // ...
  }
}

Then run the appropriate install command for your workspace manager, e.g.:

shell
# pick one
yarn
pnpm install
npm install
rush install
shell
# pick one
yarn
pnpm install
npm install
rush install

2. Define scripts to run lage​

Next, add scripts inside the workspace root package.json to run lage. For example:

/package.json
json
{
  "scripts": {
    "build": "lage build",
    "test": "lage test"
  }
}
/package.json
json
{
  "scripts": {
    "build": "lage build",
    "test": "lage test"
  }
}

3. Add a lage.config.js file to configure the pipeline​

Create a file lage.config.js at the workspace root, and configure task dependencies using the pipeline. For example:

/lage.config.js
js
module.exports = {
  pipeline: {
    build: ["^build"],
    test: ["build"],
    lint: []
  }
};
/lage.config.js
js
module.exports = {
  pipeline: {
    build: ["^build"],
    test: ["build"],
    lint: []
  }
};

See the Pipelines page for more info about this syntax.

4. Run lage commands​

You are now ready to start running all the commands in your repository with lage. You'll notice that tasks are now cached!

shell
# choose one
yarn build
npm run build
pnpm run build
shell
# choose one
yarn build
npm run build
pnpm run build