返回 Skill 列表
extension
分类: 开发与工程无需 API Key

project-scripts

标准化项目生命周期脚本(setup, run, stop, archive)在scripts/目录下,以便代理可以通过单一接口跨运行时管理工作区。脚本是可移植的bash;当可用时,mise是推荐的编排器,并且提供了Conductor、Claude Code hooks、devcontainers、Cursor和Codex的适配器。在引导生命周期脚本、审计项目的设置/运行工作流或将脚本连接到如mise.toml或conductor.json这样的运行时配置时使用。

person作者: jakexiaohubgithub

Project Scripts

Single-file shell scripts in scripts/ are the portable source of truth for project lifecycle actions. When mise is available, it orchestrates them with dependency management and environment injection. Runtimes (Conductor, Claude Code, devcontainers) invoke scripts through their own config formats — they decide when lifecycle actions run.

The Four Actions

| Action | Purpose | When it runs | |--------|---------|-------------| | setup | Install deps, link env, run migrations | Workspace creation, CI start | | run | Start dev server or primary workflow | Development, may be long-running | | stop | Stop processes, clean transient state | Workspace pause, session end | | archive | Package outputs, push branches, clean up | Before workspace destruction |

setup

Idempotent and fast when nothing has changed. Should check state before doing work — if deps are installed and env is linked, exit early. Safe to run repeatedly.

run

Start the dev server or main workflow. May be long-running (blocks until killed). For projects without a dev server, this can run tests or a REPL.

stop

Idempotent process cleanup. Kill dev servers, remove temp files. Must be safe to call multiple times or when nothing is running. A missing stop script is a no-op.

archive

Prepare for workspace teardown. Depends on stop — mise handles this automatically via #MISE depends=["stop"]. For non-mise callers, archive scripts defensively call scripts/stop before cleanup.

Script Conventions

  • Location: scripts/{action} (extensionless preferred) or scripts/{action}.sh
  • Shebang: #!/usr/bin/env bash with set -euo pipefail
  • Optional #MISE metadata comments for description, dependencies, tool requirements
  • No positional args — use env vars ($CONDUCTOR_ROOT_PATH, $CLAUDE_PROJECT_DIR)
  • Idempotent where possible, exit non-zero on failure
  • setup must be idempotent and fast — exit early when nothing to do
  • stop must always be idempotent — safe to call when nothing is running
  • archive should call scripts/stop before cleanup (defensive fallback for non-mise callers)
  • Missing script = no-op (not all projects need all four actions)
  • Maintain a scripts/README.md as a quick index — update it when scripts are added or changed

scripts/README.md

Every scripts/ directory should include a README.md that indexes the available scripts with a brief description of each. This serves both humans browsing the repo and agents discovering available lifecycle actions.

Updating the README:

  • Read the existing README before modifying — never blindly overwrite it
  • Projects accumulate utility scripts beyond the four lifecycle actions; preserve descriptions and sections added by humans
  • Add new scripts to the appropriate table; remove entries for deleted scripts
  • If the README has custom sections (e.g., grouped tables for lifecycle vs utility scripts, usage notes, examples), preserve that structure and add within it
  • Descriptions should be written by the agent based on reading the actual script, not from a template
  • Bootstrap generates a starter README; all subsequent updates should be surgical edits

Example (initial bootstrap):

# Scripts

Project lifecycle scripts. Run with `mise run <name>` or `bash scripts/<name>`.

| Script | Description |
|--------|-------------|
| `setup` | Install deps, link env. Idempotent — exits fast when nothing to do. |
| `run` | Start dev server (`bun dev`). |
| `stop` | Stop dev server. Idempotent — safe when nothing is running. |
| `archive` | Teardown workspace. Stops processes, cleans build artifacts. |

#MISE metadata

Scripts can include optional mise metadata as comments. These are ignored by bash but enable mise features when invoked via mise run:

#!/usr/bin/env bash
#MISE description="Install deps, link env"
#MISE depends=["other-task"]
#MISE tools={bun="1.1"}
set -euo pipefail
bun install

mise Integration (Recommended)

When mise is available, it's the best way to run lifecycle scripts. One line in mise.toml bridges scripts/ to the mise task system:

[task_config]
includes = ["scripts"]

This makes all scripts in scripts/ available as mise tasks: mise run setup, mise run stop, etc.

Dependency management

With #MISE depends=["stop"] in the archive script, mise run archive automatically runs stop first. No manual chaining needed. Dependencies are resolved as a DAG.

What mise adds

| Feature | bash scripts/X | mise run X | |---------|-------------------|-------------| | Dependencies | Manual (defensive calls) | Declarative (depends) | | Tool pinning | External | #MISE tools={bun="1.1"} | | Task discovery | ls scripts/ | mise tasks ls | | Parallel execution | No | mise run setup lint test | | Environment injection | Manual | [env] in mise.toml |

Optional: mise enter/leave hooks

For projects not managed by a harness (Conductor, Claude Code, etc.), mise can optionally trigger lifecycle scripts on directory entry/exit. This is opt-in per project — do not enable this when a harness already invokes the scripts, as it would duplicate work:

[hooks]
enter = { task = "setup" }
leave = { task = "stop" }

The enter hook fires once when you cd into the project (requires mise activate in shell). Only add this when no other runtime is managing the lifecycle.

Fallback

Scripts always work as bash scripts/setup without mise. The #MISE lines are just comments to bash. This ensures portability to CI, devcontainers, and any environment where mise isn't installed.

Detection Workflow

When this skill activates:

  1. Check for scripts/ directory
  2. For each action, look for scripts/{action} then scripts/{action}.sh
  3. Check if mise.toml has task_config.includes = ["scripts"]
  4. Check existing runtime configs:
    • conductor.json — look for scripts object
    • .devcontainer/devcontainer.json — look for postCreateCommand
    • .claude/settings.json — look for hooks
  5. Report what exists and offer to fill gaps

If no scripts exist, offer to bootstrap. If scripts exist but mise integration or runtime configs are missing, offer to wire them in.

Bootstrap Workflow

To scaffold lifecycle scripts for a project:

  1. Detect ecosystem from lockfile:

| Lockfile | Ecosystem | |----------|-----------| | bun.lock | bun | | pnpm-lock.yaml | pnpm | | uv.lock | uv | | package-lock.json | npm | | Cargo.lock | cargo |

  1. Create scripts/ with ecosystem-appropriate defaults and #MISE metadata
  2. Generate scripts/README.md indexing the scripts
  3. chmod +x each script
  4. Optionally add task_config.includes = ["scripts"] to mise.toml
  5. Optionally wire into other runtime configs (conductor.json, devcontainer.json, etc.)

Automated scaffolding — run from the target project directory; scripts/bootstrap.sh is relative to this skill's base directory:

bash scripts/bootstrap.sh [ecosystem]

See references/ecosystem-templates.md for per-ecosystem script and conductor.json templates.

Wiring Into Other Runtimes

For environments without mise, each runtime has its own config format:

| Runtime | Config file | startup | teardown | |---------|------------|---------|----------| | Conductor | conductor.json | setup on create | stop then archive on teardown | | Claude Code | .claude/settings.json | SessionStart hook | session_end hook (stop + archive) | | Devcontainer | devcontainer.json | postCreateCommand | Container handles teardown | | Cursor | environment.json | workspace.setup | — | | Codex | codex.yaml | lifecycle.setup | lifecycle.stop | | GitHub Actions | .github/workflows/*.yml | run: bash scripts/setup | — |

See references/adapters.md for complete config snippets and env var details.

Migrating Existing Scripts

If a project already has bin/dev, Makefile, justfile, or similar — wrap rather than replace:

#!/usr/bin/env bash
#MISE description="Setup project"
set -euo pipefail
exec make setup

This preserves existing workflows while providing a consistent interface for mise and other runtimes.

References