Skip to main content
CLI

Link a project

Link a local directory or monorepo to Easel project(s) for CLI commands.

Link your working tree so later commands know which project to use.

easel link

In interactive terminals, the CLI lists projects in your active workspace and prompts you to pick one. In non-interactive mode, pass the project explicitly:

easel link --project my-app

The CLI stores the link at .easel/project.json in the current directory. Commit that file if your team wants a shared default project for the repo.

When one git repo contains multiple Easel projects (each with its own Root Directory), link them once from the monorepo root:

easel link --repo

Interactive mode lists workspace projects and their Root Directories. Select one or more (comma-separated numbers, or all). Non-interactive mode requires explicit projects:

easel link --repo --project front --project web

This writes .easel/repo.json at the git repository root (or the current directory if you are not in a git repo), mapping each project to its Root Directory:

{
  "workspaceId": "…",
  "workspaceSlug": "…",
  "projects": [
    { "id": "…", "slug": "front", "directory": "apps/front" },
    { "id": "…", "slug": "web", "directory": "apps/web" }
  ]
}

After linking, run commands from any subdirectory. The CLI picks the deepest matching project for your cwd:

cd apps/front && easel deploy
cd apps/web && easel logs

At the repo root (or when several projects match), pass --project or choose interactively.

Commit .easel/repo.json if your team wants a shared monorepo mapping. A nearest .easel/project.json still overrides the repo map for that directory.

You can override the project per command with --project, or select a workspace with --workspace / -W.

Next steps

On this page

Edit on GitHub