dev-installation
Skill179 starsChanged 12 days agoApache-2.0View on GitHub
The native package installer: install, update, uninstall, service registration, asset download, corp config. Use when working on those or the installed ~/.capsem/ layout.
In this repository37 other files it gives its agents.
- AGENTS.mdAGENTS.md
- asset-pipelineSkill
- build-imagesSkill
- build-initrdSkill
- citadelSkill
- dev-benchmarkSkill
- dev-bug-reviewSkill
- dev-cacheSkill
- dev-capsem-doctorSkill
- dev-capsemSkill
- dev-ciSkill
- dev-debuggingSkill
- dev-gateSkill
- dev-justSkill
- dev-mcpSkill
- dev-mitm-proxySkill
- dev-rust-patternsSkill
- dev-session-debugSkill
- dev-setupSkill
- dev-skillsSkill
- dev-sprintSkill
- dev-startSkill
- dev-testing-frontendSkill
- dev-testing-hypervisorSkill
- dev-testing-pythonSkill
- dev-testingSkill
- dev-testing-vmSkill
- frontend-designSkill
- ironbankSkill
- meta-find-skillsSkill
- meta-organize-skillsSkill
- meta-skill-creationSkill
- release-processSkill
- site-architectureSkill
- site-infraSkill
- site-marketingSkill
- use-capsemSkill
The file
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 132
Never make /dev/kvm or /dev/vhost-vsock world-writable in CI.
- Very specific: line 188
Run just _gate-install for the Linux Docker/systemd boundary.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Native Package Installer
Installed layout
~/.capsem/
bin/capsem, capsem-service, capsem-process, capsem-tui,
capsem-mcp-aggregator, capsem-mcp-builtin,
capsem-gateway, capsem-tray, capsem-admin, capsem-mock-server
assets/manifest.json, manifest-metadata.json, {asset-name}-{hash16}.{ext}
run/service.sock, service.pid, instances/, persistent/
corp.toml (CLI-provisioned corp config)
corp-source.json (corp config source metadata)CLI commands (no service required)
These commands dispatch before UdsClient creation -- they work without the service running:
| Command | Module | What |
capsem version | main.rs | Print version + build hash |
capsem update | update.rs | Check the selected release manifest URL and report the matching binary installer |
capsem service install|uninstall|status | service_install.rs | Service registration |
capsem completions bash|zsh|fish | completions.rs | Shell completions |
capsem uninstall --yes | uninstall.rs | Full removal |
Path discovery (paths.rs)
discover_paths() finds sibling binaries and assets:
current_exe().parent()-> bin_dir -> the packaged host binary cohort:capsem,capsem-service,capsem-process,capsem-tui,capsem-mcp-aggregator,capsem-mcp-builtin,capsem-gateway,capsem-tray,capsem-admin,capsem-mock-server- Assets:
~/.capsem/assets/(the only installed layout -- packages install manifest URL provenance, then postinstall hydrates the live manifest and assets throughcapsem update --assets --manifest <URL>)
Auto-launch (main.rs UdsClient)
try_ensure_service() runs on every service-dependent command:
- Check socket connectivity
- Try systemd/LaunchAgent if unit installed (via
try_start_via_service_manager()) - Fall back to direct spawn only for explicit development commands; installed package paths are otherwise authoritative
- Poll socket for 5s
The request() method wraps all HTTP calls with retry-on-connect-fail.
The host MCP server is the separately installed @capsem/mcp npm package.
Native installation must not install Node.js or download that package.
Service registration (service_install.rs)
Pure generators (unit-testable on all platforms):
generate_plist()-> macOS LaunchAgent XMLgenerate_systemd_unit()-> systemd user unit
Side-effecting:
install_service()-> write +launchctl bootstrap/systemctl --user enable --nowuninstall_service()->launchctl bootout/systemctl --user disable --now+ deleteservice_status()-> installed + running + pid + unit_path
Package install
The package is the install unit. It may accept a manifest URL override for corp
and development installs, records that URL in packaged
manifest-metadata.json, hydrates the live manifest through
capsem update --assets --manifest <URL> during postinstall, installs/restarts
service files, and writes timestamped install logs. Packages do not carry a
~/.capsem/assets/manifest.json payload: VM
assets are the channel's one runtime, hydrated from the manifest. They do not run an AI-provider setup wizard and
they do not create a user policy file.
Postinstall writes the selected verified release document unchanged to
~/.capsem/assets/manifest.json. The boot resolver derives its compact runtime view in
memory; it must never serialize that view over the installed release graph.
The adjacent ~/.capsem/assets/manifest-metadata.json sidecar, with schema
capsem.manifest_metadata.v1, is the only sidecar for provenance and update
state. CLI status and About Capsem both read the service's canonical
GET /system/status response, which includes those exact two JSON documents.
The public installer fetches the selected manifest once and hands postinstall
two identities: its logical URL and root-owned exact payload bytes. The hidden
preactivation rail consumes those bytes through stdin, uses the logical URL for
relative assets and checked_url, and preserves the package-owned polling URL,
channel, and origin. The request and payload remain paired for package-manager
retry after failure; postinstall removes both only after success.
Package maintainer scripts
- macOS
.pkg:build_system/packaging/macos/pkg-scripts/preinstallunloads the LaunchAgent, kills stale package-owned helpers, removes old app/share payloads, thenbuild_system/packaging/macos/pkg-scripts/postinstallcopies binaries, hydrates assets, registers the service, waits for service/gateway readiness, and opens the app. - Linux
.deb:build_system/packaging/linux/deb-preinst.shis packaged asDEBIAN/preinst. It requires a non-root installing account from sudo'sSUDO_USER(or an explicit non-rootUSERin the package environment). A root-only unattended install fails rather than choosing UID 1000. Both maintainer scripts run every~/.capsemwrite, log append, and deletion as that account; root handles only package-owned paths and VM-device setup. The preinstall helper also drops to that account before signalling a checked process, closing PID-reuse races across users. Preinstall normally runssystemctl --user stop capsem.servicewhen a user systemd session is available, then kills the stale helper cohort before package replacement so old service/gateway/tray/process binaries cannot survive from old inodes. A self-update started by an older installed service is the one exception:/proc/self/cgroupproves thatdpkgbelongs tocapsem.service, so preinst preserves that unit and cohort until the old updater activates the new manifest and requests its managed restart. Postinstall detects the same service-owned transaction and defers manifest hydration, update-status refresh, service registration, and readiness because the public manifest still selects the previous package until publication and the new client must not probe the deliberately preserved old service; the old updater already owns the exact preverified candidate and final restart. This is the bootstrap for releases whose previous service does not yet contain the siblingsystemd-runupdater. For ordinary installs,build_system/packaging/linux/deb-postinst.shsymlinks the packaged binaries into~/.capsem/bin, hydrates assets, and invokescapsem installto register or enable the user service without restarting an already active unit mid-transaction. Adding the user tokvmis not immediate access for an already-runningsystemd --usermanager: postinstall must apply the shared narrow ACL helper after the packaged udev rule, and the Docker/systemd proof deliberately starts its manager before installation to preserve that test. Never make/dev/kvmor/dev/vhost-vsockworld-writable in CI; doing so hides the installed-package permission boundary.
Self-update (update.rs)
read_cached_update_notice()-> sync file read on every commandrefresh_update_cache_if_stale()-> background 24h-cached check merged atomically into the installedmanifest-metadata.jsonsidecarrun_update()-> check the selected manifest URL and stage one complete compatible release transaction before mutating the installationcapsem update --yes-> verifies every changed package/runtime artifact, prints the tested package-manager apply command for audit, executes it throughsudowhen the native package changes, and atomically activates the selected release graph; this is the one ordinary update path used by the installed service. It also removes a leftover~/.capsem/profilesdirectory from older installs with a no-follow contained removal (a symlink is removed as the link)capsem update --assets-> low-level diagnostic/repair rail for hydrating the locally installed manifest or an explicit--manifestURL; normal product surfaces never direct users to apply assets separately- Corporate VM asset channels use
capsem update --assets --manifest <URL>;--corp <URL>provisions policy config and must not be combined with--assets --manifestand--corpare URL-only inputs. Local files must usefile:///absolute/path, while hosted release and corporate channels usehttps://...orhttp://...; bare paths are rejected so update checks share one URL-based mechanism.- Stable/nightly switching uses the one complete installed transaction:
capsem update --yes --channel <stable|nightly>. Explicit channel transitions may downgrade; Linux usesapt-get --allow-downgrades. The single metadata file records the installed manifest URL separately from the most recently checked URL. - An explicit corporate asset manifest moves the installation into a one-way locked channel. Persist
channel_kind=corporateandchannel_locked=true; later public-channel or different-manifest selections must fail before fetch or mutation. - Runtime images/evidence belong to the selected channel's one
runtimedocument. Updating the nightly runtime can refresh only nightly runtime image refs and matching digests; it must not mutate stable, packages, or per-binary inventory. - The runtime may set
min_capsem_versionwhen it requires newer client behavior. That is the compatibility hook; the runtime must not point at the selected Capsem binary. - Layout detection: MacosPkg, LinuxDeb, UserDir, Development (development bails with "build from source")
- Pre-updater installed binaries cannot be retrofitted through the release
channel. If a shipped binary prints "Binary self-update is not yet wired up",
that install needs one manual
.pkgor.debbootstrap into a version that contains the package apply path; only then can later binary releases move throughcapsem update --yes. - Installed update smokes require that all packaged host binaries expose a version surface and report the same installed Capsem package version after replacement.
Corp config provisioning (capsem-core: corp_provision.rs)
fetch_corp_config(url)-> GET + validate + return content + ETagvalidate_corp_toml(content)-> parse as SettingsFileinstall_corp_config(dir, content, source)-> write corp.toml + corp-source.jsonrefresh_corp_config_if_stale(dir)-> background conditional GET with ETag
Loader changes: corp_config_paths() returns [/etc, ~/.capsem/] with first-wins merge.
Remote manifest + asset download (capsem-core: asset_manager.rs)
download_missing_assets(manifest, binary_version, arch, dir, progress)-> hydrate missing or corrupt assets from the manifest's release-channel URLscopy_missing_local_assets(...)-> same contract forfile://corporate/local manifestscleanup_unused_assets(base_dir, manifest)-> remove hash-named files no longer referenced by non-deprecated releases
Test harness
Docker-based e2e tests in tests/capsem_install/:
| File | Tests |
| test_smoke.py | Harness works (systemd, binaries, build hash) |
| test_auto_launch.py | Auto-launch, path discovery, asset resolution, error cases |
| test_service_install.py | Install/uninstall/status, idempotent, systemd integration |
| test_corp_config.py | Provisioning, validation, precedence |
| test_update.py | Dev build bail, layout detection, cache, preserve-on-fail |
| test_completions.py | bash/zsh/fish output |
| test_uninstall.py | Full cleanup |
| test_lifecycle.py | End-to-end user journey |
| test_reinstall.py | Binary replacement verification |
| test_error_paths.py | Failure scenarios with actionable errors |
Run just _gate-install for the Linux Docker/systemd boundary. On Apple Silicon
macOS, run python3 build_system/packaging/macos/macos_release_glowup.py for the exact .pkg build, clean Tart
install, receipt/app/binary verification, and service health. Because Tart
macOS guests cannot expose nested virtualization, the recipe then extracts the
same package on the physical Mac and boots a real Capsem guest from its exact
binary/runtime payload to a shell marker. Both focused scripts remain
debugging tools; just test is the release gate that owns them.
The Linux qualification image is a visible four-step graph: capacity, dependency materialization, sealed source build, and sealed smoke. Only the input-keyed materializer may use BuildKit's ordinary network; it consumes the exact host-platform parent, immutable Ubuntu snapshot, locked uv environment, and frozen pnpm store. Source build, smoke, and the privileged systemd runtime all use networking disabled. They bind the runnable input-keyed tag to the exact platform-child ID before use; the child ID is evidence but is not itself runnable on every containerd store. Do not repair a failure with runtime apt, pnpm, uv sync --project build_system, a second build, or an unverified image tag.
Manifest-selected runtime content includes a verified immutable input subtree
under the same RuntimeContent root as assets. Mount
that root read-only, reverify it inside the container, and use the extracted
capsem-admin from the exact package to author the checked local package/runtime
graph before the single dpkg -i. The narrower Debian proof uses the same graph
primitive and secure handoff; neither proof may fall back to a public URL.
The local .pkg is intentionally unsigned. Its installer postinstall applies
ad-hoc signatures and the required entitlements to executable payloads, which
the Tart guest verifies before service and gateway checks. Local installation
tests must not import or unlock an Apple Developer certificate or mutate the
user's keychain. Developer ID signing, notarization, and stapling are
publication-workflow responsibilities.
Key files
crates/capsem/src/
main.rs CLI entry, command dispatch, UdsClient with auto-launch
paths.rs Binary + asset path discovery
platform.rs Install layout detection
package.rs Package install orchestration and manifest placement
update.rs Self-update + cache
service_install.rs LaunchAgent + systemd unit generation + registration
completions.rs Shell completions via clap_complete
uninstall.rs Full removal
build.rs Build hash embedding (CAPSEM_BUILD_HASH)
crates/capsem-core/src/
asset_manager.rs Remote manifest, background download, cleanup
net/policy_config/
corp_provision.rs Corp config fetch, validate, install, refresh
loader.rs corp_config_paths() with mergeDoes it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

