Cfgd

io.github.tj-smith47由 GitHub 账号 tj-smith47 发布v0.12.0更新于 Oct 24, 2026

Declarative, GitOps-style machine configuration management

概览

AI 生成的概览

把 cfgd 声明式机器配置命令行工具暴露为 MCP 工具,让助手能够规划、应用并持续校准工作站的声明状态。

可以做什么
Cfgd 是 GitOps 风格的机器配置管理工具:软件包、dotfiles、系统设置和密钥都以受版本控制的 YAML 配置档与模块声明,再与机器实际状态比对并校准。其 MCP 服务器把命令行工具本身作为工具提供,因此助手不只是写配置,还能驱动校准过程。相关能力包括 AI 辅助生成配置、可共享的跨平台模块、漂移检测以及密钥后端。
适用场景
当你希望助手依据声明配置来初始化或校准开发机,或检查并修正多台机器之间的漂移时,值得安装。适合在多台工作站之间管理 dotfiles 与软件包的开发者,以及分发共享环境模块的团队。
运行要求
以 stdio 方式作为本地进程运行,因此机器上必须安装 cfgd 可执行文件(可通过 Homebrew、cargo、安装脚本等渠道)。清单未声明任何认证、环境变量或请求头。部分功能需要额外凭据,例如 AI 辅助生成需要 ANTHROPIC_API_KEY,密钥后端涉及 SOPS/age、1Password、Bitwarden 或 Vault。
安装前请注意
该服务器驱动的工具会改动机器:安装软件包、写入文件,并可自动修正漂移,因此操作可能修改或删除现有配置。它还可能通过 SOPS/age、1Password、Bitwarden、Vault 等后端处理密钥,并涉及 SSH 与 GPG 密钥的生成与管理。项目标注为 Alpha,API 可能变化。应用前请先审阅计划。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Cfgd,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

[cfgd gear icon]

cfgd

Declare your entire machine (packages, dotfiles, system settings, secrets) with composable profiles and shareable, cross-platform modules.

[CI] [E2E] [Release] [Coverage] [License: MIT OR Apache-2.0]

[cfgd installing a Neovim setup on a bare Ubuntu container in one command]

A bare ubuntu:24.04 container with no Neovim, no Homebrew and no config. One cfgd init later, nvim opens a fully configured LazyVim. Recorded with VHS.

Status: Alpha. APIs may change.



What is cfgd

Most dotfile managers track files. cfgd manages your entire machine. You declare packages, files, secrets, and system settings in version-controlled YAML. cfgd diffs what you want against what you have, builds a plan, and reconciles continuously. If something drifts, it is detected and corrected.

How It Works

Profiles declare your machine's desired state: packages, files, system settings. They compose via inheritance: share a common base across machines, then specialize per context. See docs/profiles.md.

             base            ╱    ╲        work    personal       ╱    ╲  laptop    devcontainer

Modules are shareable, self-contained config packages. Install someone else's dev environment or publish your own. Cross-platform package resolution picks the right manager automatically. See docs/modules.md.

Reconciliation continuously ensures machines match their declared state. Drift is detected, reported, and optionally auto-corrected. Failed actions don't abort; they're logged and skipped. See docs/reconciliation.md, or watch two machines converge through the daemon.

[cfgd catching a sabotaged file with cfgd status, explaining it with cfgd diff, and healing it with cfgd apply]

Quick Start

sh
# Install via Homebrewbrew install tj-smith47/tap/cfgd
# Or via install scriptcurl -fsSL https://github.com/tj-smith47/cfgd/releases/latest/download/install.sh | sh
# Or via cargocargo install cfgd
# Bring your config to a new machine in secondscfgd init --from [email protected]:you/machine-config.git
# Or start freshcfgd init
# Or let AI scan your system and generate config for youexport ANTHROPIC_API_KEY=sk-...cfgd generate
# Set up shell completions (add to your shell's rc file)source <(cfgd completion bash)  # .bashrcsource <(cfgd completion zsh)   # .zshrccfgd completion fish | source   # config.fish

Why cfgd exists

I recently switched jobs, and spent the last week of my old job backing up scripts and dotfiles, parsing out company-specific info, and composing a tarball to transfer. At the new job, I spent another few days getting my new machine reconfigured. Over time I kept discovering things I'd forgotten, and things (System Settings, for one) I wished the backup had covered. It all felt manual and incomplete: I should be able to clone a repo and have my entire workstation (packages, scripts, dotfiles, system settings) feel familiar again. Better still, to keep parts of that feeling in sync between my home and work laptops.

The other inspiration was devcontainers. At my previous company I had set up custom scripts to inject dotfiles into the devcontainer so a user could replicate their dev environment once they shell in. At minimum, I wanted my full Neovim setup available in any ephemeral container without modifying the devcontainer config in every team's repository to accommodate it. I needed something that could bootstrap my config into any environment from the outside, regardless of whose repo I was working in. Plus, I had some coworkers in need of education about the superiority of vim-motions, and wanted a quick way to share my exact setup, down to the alias.

cfgd borrows from the best ideas across practices:

  • Kubernetes: declarative reconciliation loop, KRM resource model
  • Terraform: plan/apply workflow, state tracking, drift detection
  • Puppet: continuous enforcement via daemon, module ecosystem
  • Nix: reproducible machine state from a single source of truth
  • Ansible: YAML-driven config management, idempotent task execution
  • Kustomize: layered overrides and patches
  • chezmoi: dotfile management

Shareable Modules

This is my favorite feature: a single packaged config for a tool that works anywhere.

sh
cfgd module create my-dev-envcfgd profile update --module community/nvim

A module declares packages with cross-platform resolution, config files, shell environment variables and aliases, and lifecycle scripts:

yaml
apiVersion: cfgd.io/v1alpha1kind: Modulemetadata:  name: nvim  description: Neovim editor configurationspec:  depends: [node, python]  packages:    - name: neovim      minVersion: "0.10"      prefer: [brew, snap]      deny: [apt]    - name: ripgrep    - name: fd      aliases:        apt: fd-find        dnf: fd-find    - name: gcc      aliases:        apt: build-essential        dnf: "@development-tools"      platforms: [linux]  files:    - source: files/init.lua      target: ~/.config/nvim/init.lua    - source: files/lua      target: ~/.config/nvim/lua  env:    - name: EDITOR      value: nvim  aliases:    - name: v      command: nvim  scripts:    postApply:      - nvim --headless '+Lazy! sync' '+MasonToolsInstallSync' +qa

See docs/modules.md for the full spec including git file sources, registries, and dependency resolution.

How cfgd compares

cfgdchezmoiNix Home ManagerAnsiblePuppet
FocusFull machine stateDotfilesDotfiles + packages (Nix)General automationServer/infra state
Packages18 managersNoneNix onlyAny (via tasks)Any (via providers)
Drift detectionContinuous (daemon)ManualOn rebuildManualContinuous (agent)
Cross-platform resolutionPer-package manager mappingN/ANix-onlyPer-task conditionalsPer-OS Hiera data
Shareable modulesFirst-classTemplates onlyFlakesRoles (Galaxy)Forge (server-oriented)
Team configPolicy tiers + CrossplaneN/AFlake inputsN/APuppet Enterprise
InfrastructureSingle binary, zero serversSingle binaryNix daemonSSH (or AWX)PuppetServer + PuppetDB + CA
Learning curveYAML + CLIGo templatesNix languageYAML + Jinja2Puppet DSL (Ruby)

Puppet is the closest philosophical match: declarative state, continuous enforcement, module ecosystem. If that model clicked for you but standing up a JVM server and writing a Ruby-era DSL to manage your dotfiles in 2026 doesn't, cfgd is what that idea looks like rebuilt from scratch for developer workstations.

cfgd is a good fit when you want: one-liners for cross-platform machine bootstrapping, shareable dev environment modules, continuous reconciliation between machines or subscribed sources, or team config distribution with policy enforcement.

Features

For developers:

  • One-command bootstrap: cfgd init --from <repo> --apply on a new machine
  • AI-guided generation: cfgd generate scans your system and builds profiles/modules; MCP server for AI editor integration
  • MCP server: cfgd mcp serves the CLI itself as tools, so an assistant can reconcile a machine, not only write config for one
  • Authoring skills: cfgd skill install teaches your coding agent (Claude Code, Gemini, Copilot, Codex, Cursor) to author high-quality cfgd resources
  • Shareable modules: cross-platform dev environment packages with dependency resolution and registries
  • 18 package managers: brew, apt, dnf, pacman, cargo, npm, pipx, snap, and more, with automatic platform-aware resolution
  • Secrets: SOPS/age encryption + 1Password, Bitwarden, HashiCorp Vault; secret-backed environment variables
  • Tera templates: render dotfiles with variables, OS detection, custom functions
  • Continuous drift detection: daemon watches for changes, auto-syncs, notifies or auto-corrects

For platform & infrastructure engineers:

  • Multi-source config: publish team baselines with policy tiers (locked/required/recommended/optional)
  • Kubernetes operator: CRDs for MachineConfig, ConfigPolicy, ClusterConfigPolicy, DriftAlert, BackupPolicy, Module; admission webhook; device gateway with fleet dashboard
  • Node configuration: sysctl, kernel modules, containerd, kubelet, AppArmor, seccomp, certificates
  • CSI driver: OCI-based module injection into pods via volumes
  • Crossplane integration: TeamConfig XR for self-service team environment distribution
  • kubectl plugin: kubectl cfgd debug/exec/inject/status for node inspection

For security & compliance:

  • Compliance snapshots: continuous machine state capture with JSON/YAML export for Vanta, Drata, or custom integrations
  • Key provisioning: declarative SSH key generation, GPG key management, and git signing configuration
  • Encryption enforcement: per-file encryption requirements with SOPS/age backend validation
  • Policy enforcement: locked files, required packages, encryption constraints on target paths
  • Drift remediation: daemon detects and auto-corrects configuration drift with per-module policies
  • Fleet visibility: device gateway aggregates compliance scores across enrolled machines

Documentation

DocumentDescription
ConfigurationRoot config (cfgd.yaml), file strategies, aliases, themes
ProfilesProfile YAML, inheritance, merge rules, variables
ModulesModule spec, cross-platform packages, dependencies, git file sources, registries
ReconciliationPhase ordering, failure handling, state store
PackagesAll package managers, skip behavior, dry-run
TemplatesTera template system, context variables, custom functions
SecretsSOPS/age backends, 1Password, Bitwarden, Vault
System ConfiguratorsShell, macOS defaults, systemd, sysctl, kubelet, and more
SourcesMulti-source config, policy tiers, composition, subscriptions
DaemonFile watching, reconciliation loop, sync, notifications, service install
OperatorCRD-based machine management, device gateway, DaemonSet node agent
Team ConfigCrossplane-powered team config distribution
SafetyAtomic writes, backups, rollback, apply locking, path safety
Declarative Backupsspec.backups[] snapshots, hook ordering, retention, restoring
Backup PolicyFleet-wide backup schedules, the precedence table, scheduleOwner
CLI ReferenceComplete command reference with flags and examples
InstallationEvery install channel, verifying signed downloads, self-upgrade
Bootstrapcfgd init flow, apply options, install script
AI GenerateAI-guided config generation, both MCP servers (mcp-server for authoring, mcp for driving the CLI)
Authoring Skillscfgd skill installer, supported agent providers, choosing between generate and skills
ReleasingCI-cut release pipeline, pre-release checklist, failure recovery
Image PackPacking a directory into an OCI image volume, signing, pinning deployments
Multi-TenancyNamespace isolation and tenant boundaries for the operator
Lifecycle Scriptsrun: resolution, hook phases, timeouts, interactive scripts

Distribution

In addition to publishing binaries to GitHub Releases (Linux, macOS, Windows on amd64 + arm64; FreeBSD on amd64), each release also publishes to:

ChannelArtifact
Homebrewbrew install tj-smith47/tap/cfgd
crates.iocargo install cfgd (or cargo binstall cfgd for the pre-built binary)
AURyay -S cfgd (Arch Linux; builds from source)
wingetwinget install --id TJSmith.cfgd
Scoopscoop bucket add tj-smith47 https://github.com/tj-smith47/scoop-bucket; scoop install cfgd
Chocolateychoco install cfgd
Nixnix profile install github:tj-smith47/nix-pkgs#cfgd
deb / rpm / apkStatic-binary native packages, also mirrored to CloudSmith
GHCRDocker images: cfgd, cfgd-operator, cfgd-csi
Helmhelm install cfgd oci://ghcr.io/tj-smith47/charts/cfgd
Krewkubectl krew install cfgd (the kubectl plugin for node debugging and fleet inspection)
OLMOperator bundle for OLM-managed clusters
Crossplanefunction-cfgd composition function for team config distribution
MCP Registryio.github.tj-smith47/cfgd: the cfgd mcp-server stdio server, for AI agents and editors

CI/CD integrations:

IntegrationDescription
cfgd SetupGitHub Action: bootstrap a runner with a module from your config repo
cfgd PlanGitHub Action: run cfgd plan on PRs, post the diff as a comment
GitLab CIIncludable .cfgd-ci.yml template with .cfgd-plan and .cfgd-apply jobs
Tektoncfgd-apply Task for Tekton Pipelines
yaml
# Example: set up your dev tools on a GitHub Actions runner- uses: tj-smith47/cfgd/ecosystem/github-actions/setup@master  with:    source: [email protected]:you/machine-config.git    module: dev-tools
# Example: plan config changes on every PR, comment the diff, gate the merge- uses: tj-smith47/cfgd/ecosystem/github-actions/plan@master  with:    config-dir: .    fail-on-error: true

Modules can also be exported as DevContainer Features for injection into devcontainers:

sh
cfgd module export my-tool --as devcontainer

Building from source:

sh
git clone https://github.com/tj-smith47/cfgd.git && cd cfgdcargo build --release

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

来源:README.md,提交 8182594

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

3
  1. v0.12.0最新Oct 6, 2026
  2. v0.11.0Sep 17, 2026
  3. v0.10.0Sep 16, 2026

评分

已满足适用检查项的 40%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。