- Swift and Make.
- Homebrew for
make init, which installs actionlint, dprint, pre-commit, and SwiftLint. - Docker for container-based Linux build and test targets.
Clone the repository and build:
git clone https://github.com/techprimate/apple-docs-cli.git
cd apple-docs-cli
make build
./dist/apple-docs --helpThe release binary is written to dist/apple-docs. You can run it directly or install it into a directory on your PATH.
From the repository root, install development tools and resolve SwiftPM dependencies:
make initInstall the Git hooks separately:
pre-commit installmake init requires Homebrew. If you manage development tools yourself, install the tools listed above and run make resolve to resolve SwiftPM dependencies.
| Command | Purpose |
|---|---|
make run ARGS="types view Button --technology SwiftUI" |
Run the executable through SwiftPM. |
make build |
Build the release binary at dist/apple-docs. |
make test |
Run the test suite. |
make test-linux |
Run tests in pinned Swift containers for amd64 and arm64. |
make test-integration |
Build the release binary and run live tests against Apple documentation. Requires internet access. |
make analyze |
Run SwiftLint, formatting checks, and actionlint. |
make format |
Format Swift with swift format and JSON, YAML, Markdown, and TOML with dprint. |
make help |
Show all development commands. |
Start with the tests for the behavior you changed. For support commands and their live Apple pages:
make test TEST_ARGS="--filter SupportCommandTests --filter SupportRendererTests"
make test-integration INTEGRATION_FILTER=SupportCommandIntegrationTests
./dist/apple-docs support view --path support/fee-waiver --agent --jsonThe live suite exercises catalogs, guide contents, glossary definitions, terms resources, and supported HTML layouts. It requires internet access and runs against the release executable, not a mocked service.
For bundled research skills, verify discovery, retrieval, and the existing installation behavior:
make test TEST_ARGS="--filter BundledAgentSkillsTests --filter AgentSkillsCommandTests --filter AgentSkillsInstallationTests"
make build
./dist/apple-docs agent skills list
./dist/apple-docs agent skills get apple-docs
./dist/apple-docs agent skills install --all --dry-run --projectUse a dry run to inspect installation destinations without changing agent configuration. Follow the repository instructions for source organization and skill bundling. Focused checks supplement the full verification commands below.
Container commands mount the source read-only and keep build products in Docker volumes, separate from the host build directory. The two test architectures use isolated volumes. Select one architecture or narrow the tests when needed:
make test-linux-amd64
make test-linux-arm64 TEST_ARGS="--filter AppleDocumentationRepositorySearchTests"
make build-linux-native
make test-integration-linuxLive integration tests require internet access. Both integration targets accept INTEGRATION_FILTER=SuiteName. make test also accepts TEST_ARGS.
For static release builds, use a Swift.org toolchain matching the SDK configured in the Makefile, not Xcode's bundled compiler:
make install-linux-sdk
make build-linux SWIFT_SDK=x86_64-swift-linux-musl
make build-linux SWIFT_SDK=aarch64-swift-linux-muslAlternatively, install the SDK and build inside the container without changing the host toolchain:
make install-linux-sdk-container
make build-linux-container SWIFT_SDK=x86_64-swift-linux-musl
make run-linux ARGS="swift sdk list"Container targets accept LINUX_DOCKER_FLAGS. Direct container targets also accept LINUX_BUILD_VOLUME and LINUX_SDK_VOLUME to isolate build and SDK storage. Static outputs remain in SwiftPM's SDK-specific release directory. make build-linux-native uses the container's libc for release CLI integration tests.
Follow the repository instructions, keep changes focused, and add a regression test for behavior changes and bug fixes.
Run make test, make analyze, and make build. After Swift edits, run make format and rerun make analyze. For command-facing changes, also exercise the affected release command directly.