Configure your project
Set up a repository's scripts, actions, and local files for new workspaces
Conductor can prepare every new workspace the same way, run your project from the Run button, and copy local files that Git does not track.
For most projects, start by asking Conductor to inspect the repository and configure it for you. Use the rest of this page to review what changed or make manual edits.
Quick start: ask Conductor
Configure with Conductor
Open Conductor with the setup prompt pre-filled, or copy it into an existing workspace.
View prompt
Use the bundled Conductor skill. Inspect this repo and configure the best Conductor scripts and actions for it with the Conductor `GetRepositorySettings` and `UpdateRepositorySettings` tools. These tools save the settings for this repository on my Mac; do not create or edit settings files such as `.conductor/settings.toml`, `.conductor/settings.local.toml`, or `conductor.json`, because Conductor on this Mac doesn't read them. Requirements: - Call `GetRepositorySettings` first, and preserve existing settings unless clearly wrong. - Configure the setup script, the archive script if one is useful, and actions for running the project (for example a dev server and tests). - Follow the repo's existing package manager, scripts, and setup conventions. - Keep commands simple, non-interactive, non-destructive, and workspace-safe. - Use `CONDUCTOR_PORT` in actions when the project supports configurable ports, and make those actions available only locally. - Set the run mode if concurrency behavior is clear. - If the `UpdateRepositorySettings` tool isn't available, don't write settings files; tell me what to enter in the repository's settings in Conductor instead. Inspect the usual sources: package files, lockfiles, README/contributing docs, Makefile/justfile/taskfile, Docker/Procfile config, and existing `scripts/` or `bin/`. After saving, summarize what you configured and why, and one quick Conductor test I can run.
If you have more than one repository in Conductor, create a workspace in the project you want to configure, then paste this prompt there.
The agent saves the setup script and actions to the repository's settings in Conductor. It doesn't change files in your repository. Review the result on the repository's Scripts and Actions tabs in Settings.
Add a setup script
The setup script runs when Conductor creates a workspace. Use it for commands that prepare the workspace:
- Install dependencies.
- Generate files.
- Create symlinks.
- Initialize local project state.
Open Settings, select the repository, and enter the commands on the Scripts tab:
pnpm installFor details, see Setup scripts.
Add an action
An action adds an app, server, test watcher, or other useful project command to the Run button. Add one under Custom actions on the repository's Actions tab.
Use CONDUCTOR_PORT when the command starts a local server:
pnpm dev --port $CONDUCTOR_PORTAdd more actions when the project has several useful commands, such as starting a web app, starting a worker, or running a test watcher. Conductor gives each workspace its own port range, so multiple local servers can run at the same time. For details, see Actions and Conductor variables.
Copy local files when needed
New workspaces start with files tracked by Git. Gitignored files such as .env.local, local certificates, and machine-specific config appear only when Conductor copies them or your setup script creates them.
Use Files to copy for static gitignored files that every local workspace needs.
Use a setup script when the workspace needs commands, generated files, symlinks, or workspace-specific values.
Next steps
- Use Settings to see every repository setting and how repository settings override your defaults.
- Use Setup scripts, Files to copy, and Shell configuration when you need workspace setup details.
- Use Share scripts with teammates when everyone on the team should run the same setup.