メニュー
Use when writing or updating Sake documentation — VitePress site structure, existing pages, how to add new docs, documentation conventions.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Use when working on CI workflows, GitHub Actions, release process, changelog generation (git-cliff), or dependabot configuration.
Use when working on SakeCLI or SakeCLILibrary targets — CLI entry point, config resolution, SakeAppManager build/run lifecycle, error handling, shell execution.
Use when writing or modifying Sake commands, CommandGroups, SakeApp files, or SakeApp/ directory code. Covers Command struct, dependencies, skipIf, context, storage, subprocess patterns, argument parsing.
Use when working on Sake configuration — .sake.yml, environment variables, CLI options, ConfigManager, ConfigResolver, or adding new config options.
Use when modifying the @CommandGroup macro in SakeMacros target — SwiftSyntax ExtensionMacro, code generation patterns, testing with assertMacroExpansion.
Use when writing or running tests for the Sake project — unit tests, macro expansion tests, integration tests, test helpers, and CI test commands.
| name | sake-docs |
| description | Use when writing or updating Sake documentation — VitePress site structure, existing pages, how to add new docs, documentation conventions. |
Documentation site: sakeswift.org, built with VitePress, deployed via GitHub Pages.
All docs in docs/. Key files:
docs/
index.md — landing page
about.md — what Sake is
installation.md — brew, mint, mise
getting-started.md — sake init, first command
how-it-works.md — sake vs SakeApp architecture
editing-commands.md — sake edit, manual editing
commands-basic-rules.md — visibility, static, type rules
commands-dependencies.md — deps, concurrent, CommandRunner
commands-conditional-execution.md — skipIf
commands-grouping.md — @CommandGroup, SakeAppConfiguration
commands-name-conversions.md — case strategies
commands-run-context.md — Context properties, mapArguments/mapEnvironment
passing-arguments.md — basic argument passing
sharing-data-between-commands.md — context.storage
interruption-handling.md — InterruptionHandler, SIGINT cleanup
advanced-argument-parsing.md — ArgumentParser integration
advanced-cli-tools-running.md — swift-subprocess usage
advanced-extensibility-of-sakeapp.md — adding SPM dependencies
advanced-usage-example.md — lint + ensureInstalled example
configuration.md — CLI/ENV/.sake.yml cascade
continuous-integration.md — prebuilding, caching, setup-sake action
shell-completion.md — zsh/fig completion
experimental-features.md — SAKE_EXPERIMENTAL_FEATURES, swift-syntax prebuilts
troubleshooting.md — sake clean, rm -rf SakeApp/.build
contribution-guide.md — formatting, testing, conventional commits
package.json — npm scripts and dependencies
.vitepress/config.mts — VitePress sidebar/nav config
cd docs && npm ci && npm run docs:build
Deployed automatically on push to main (docs/** changes) via .github/workflows/docs-deploy.yml.
::: tip, ::: warning, ::: info containersswift {4}outline: deep frontmatter for deep table of contents[Configuration](/configuration)docs/new-page.mddocs/.vitepress/config.mtscd docs && npm run docs:dev to preview locally