Skip to content

Document the script path environment variables #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davyrolink wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the script path environment variables #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 23 additions & 13 deletions content/docs/worktree/repo-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,27 @@ If a run-script tab is already active for that worktree, Supacode closes it befo

The setup script launches once after a new worktree is created.

Good setup scripts:

- start your coding agent
- install dependencies
- generate local artifacts
- boot a local service you always need

Example:
Good examples:

```bash
codex
```
# copy gitignored files to the worktree
cp "$SUPACODE_ROOT_PATH/.env" .env

Or:

```bash
# install dependencies
pnpm install

# generate local artifacts
pnpm prisma generate

# boot a local service you always need
docker compose up -d

# start your coding agent (codex, claude, opencode, copilot, ...)
codex
```

A new worktree contains no gitignored files. Copy the ones you need in the setup script, or enable **Copy ignored files to new worktrees** in repository settings to copy all of them, including large directories such as `node_modules`.

![Setup Script](/setup-script-claude.png)

Supacode runs the setup script inside the new worktree's terminal context, so the output is visible immediately in the app.
Expand All @@ -73,6 +74,15 @@ docker compose down

If the archive script fails, the archive does not proceed.

## Script environment

These variables are available in every Supacode terminal, including run, setup, and archive scripts:

| Variable | Value |
| --- | --- |
| `SUPACODE_ROOT_PATH` | Path to the main repository |
| `SUPACODE_WORKTREE_PATH` | Path to the current worktree |

## Where this configuration lives

These values are repository settings.
Expand Down