Supacode

https://docs.supacode.sh
Admin
Supacode is a native macOS app for running terminal-based coding workflows across multiple git...
Tokens:3,954
Snippets:88
Trust Score:5.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Setup Script

Source: https://docs.supacode.sh/worktree/repo-configuration

A simple example of a setup script. Setup scripts run once after a new worktree is created to perform initial tasks like installing dependencies or generating artifacts.

```shell
codex
```

--------------------------------

### Example Setup Script with Multiple Commands

Source: https://docs.supacode.sh/worktree/repo-configuration

An example of a setup script with multiple commands. This script installs dependencies and generates Prisma artifacts.

```shell
pnpm install
pnpm prisma generate
```

--------------------------------

### Build Supacode from Source

Source: https://docs.supacode.sh/getting-started/installation

Commands to build the Supacode application from its source code. Ensure you have the necessary prerequisites installed.

```bash
make build-ghostty-xcframework
make build-app
make run-app
```

--------------------------------

### Example Run Script Commands

Source: https://docs.supacode.sh/worktree/repo-configuration

Examples of commands suitable for the run script, which is used for repeatable on-demand tasks.

```shell
npm run dev
```

```shell
pnpm test --watch
```

```shell
bin/rails server
```

```shell
cargo test
```

--------------------------------

### Example `supacode.json` Configuration

Source: https://docs.supacode.sh/worktree/repository-settings

This JSON file configures various repository-specific settings for Supacode, including script paths, merge strategies, and worktree creation behavior. Ensure this file is placed at the root of your repository.

```json
{
  "setupScript": "codex",
  "archiveScript": "docker compose down",
  "runScript": "pnpm dev",
  "openActionID": "cursor",
  "worktreeBaseRef": "origin/main",
  "copyIgnoredOnWorktreeCreate": false,
  "copyUntrackedOnWorktreeCreate": false,
  "pullRequestMergeStrategy": "squash"
}
```

--------------------------------

### Example Archive Script

Source: https://docs.supacode.sh/worktree/repo-configuration

An example of an archive script. Archive scripts run before a worktree is archived to perform cleanup tasks, such as shutting down local services.

```shell
docker compose down
```

--------------------------------

### Start Agent with Specific Flags

Source: https://docs.supacode.sh/reference/tips

Use these commands to auto-start your agent with specific configurations. The `--dangerously-skip-permissions` flag should be used with caution.

```bash
codex
```

```bash
claude --dangerously-skip-permissions
```

--------------------------------

### Run Supacode Development Commands

Source: https://docs.supacode.sh/getting-started/installation

Common development commands for Supacode, including checks, tests, and formatting. These are useful for maintaining code quality.

```bash
make check
make test
make format
```

--------------------------------

### Global Settings File Location

Source: https://docs.supacode.sh/configuration/settings-and-storage

The global settings for Supacode are stored in this JSON file. It contains top-level keys like 'global', 'repositories', and 'repositoryRoots'.

```plaintext
~/.supacode/settings.json
```

--------------------------------

### Worktree Storage Directory

Source: https://docs.supacode.sh/configuration/settings-and-storage

Supacode organizes managed worktrees within this directory structure. Each repository has its own base directory for grouped and predictable worktree management.

```plaintext
~/.supacode/repos/<repository-name>/
```

--------------------------------

### Agent Branch Renaming Instructions

Source: https://docs.supacode.sh/reference/tips

Configure your agent to rename generic git branches to be more descriptive. This rule should not apply to the main branch.

```markdown
Before you go on your task, check the current git branch name,
if it's something generic like an animal name, name it accordingly.
Do not do this for main branch.

```
Tokens:
Raw