Skip to main content
The openlayer link command links your local directory to an Openlayer project.
If you are setting up a directory for the first time, use openlayer init instead. It signs you in, creates or links the project, and scaffolds your openlayer.json in one guided flow, so no separate link step is needed.Reach for link when your configuration already exists and you only need the link — for example to connect an existing openlayer.json to a project, or to re-point a directory at a different project. When creating a new project, link reads the task type from the openlayer.json already in the directory rather than asking for it.

​
Usage

When no arguments are provided, an interactive prompt will be displayed asking the user to confirm that they want to set up a link between the local directory and an Openlayer project, if they want to link to an existing project or create a new one, and for the project name. The --project name can also be provided as a flag:

​
Non-interactive linking

For CI and coding agents, --yes (or -y) links the directory to the project named by --project with no prompts at all. --output-mode ci implies it:
The project has to exist already: without --project, or when no project in the workspace has that name, link fails instead of asking.
If your CI job only needs to push to an existing project, set OPENLAYER_PROJECT_ID instead of linking — see environment variables.

​
Flags

Global options such as --api-key, --profile-name and --output-mode also apply.