The default plugin for Codify - a declarative system configuration tool that manages your development environment as code.

Codify allows you to define your entire development environment in a single JSON configuration file. Instead of remembering dozens of installation commands and configuration steps, you describe your desired system state and Codify makes it happen.

This plugin provides 50+ resources for managing common development tools and configurations across macOS and Linux. Think of it as Infrastructure-as-Code for your local development machine.

• homebrew - Install and manage Homebrew formulae and casks (macOS)
• apt - Debian/Ubuntu package management
• yum - RedHat/CentOS package management
• dnf - Fedora package management
• snap - Universal Linux packages
• macports - MacPorts package manager

• nvm - Node.js version management
• pyenv - Python version management
• jenv - Java version management
• asdf - Universal version manager

• npm - Node.js packages (global installs)
• npm-login - NPM authentication
• pnpm - Fast, disk-efficient package manager
• pip - Python package installation
• pip-sync - Python dependency synchronization
• virtualenv - Python virtual environments
• venv-project - Python venv projects

• git - Git configuration (name, email, signing)
• git-lfs - Git Large File Storage
• git-repository - Clone and manage git repositories
• wait-github-ssh-key - Wait for GitHub SSH key availability

• aws-cli - AWS Command Line Interface
• aws-profile - AWS credential profiles
• docker - Docker container platform
• terraform - Infrastructure as Code

• alias - Individual shell aliases
• aliases - Manage multiple aliases at once
• path - PATH environment variable management
• action - Custom shell scripts and actions

• ssh-key - Generate and manage SSH keys
• ssh-config - SSH client configuration
• ssh-add - Add SSH keys to agent

• vscode - Visual Studio Code extensions and settings
• android-studio - Android Studio IDE
• xcode-tools - Xcode Command Line Tools
• pgcli - Postgres CLI with auto-completion

• tart - macOS and Linux VM management
• tart-vm - Individual Tart VMs

• file - Local file management
• remote-file - Download and manage remote files

First, install the Codify CLI:

/bin/bash -c "$(curl -fsSL https://releases.codifycli.com/install.sh)"

Create a codify.json file in your home directory or project:

[
  {
    "type": "homebrew",
    "formulae": ["git", "node", "python"],
    "casks": ["visual-studio-code", "docker"]
  },
  {
    "type": "git",
    "name": "John Doe",
    "email": "john@example.com"
  },
  {
    "type": "aliases",
    "aliases": [
      { "alias": "ll", "value": "ls -la" },
      { "alias": "gs", "value": "git status" }
    ]
  }
]

Apply your configuration:

codify apply

That's it! Codify will install the packages, configure git, and set up your shell aliases.

[
   {
      "type": "homebrew",
      "formulae": ["postgresql@18", "redis"]
   },
   {
      "type": "nvm",
      "nodeVersions": ["20.0.0", "18.0.0"],
      "global": "20.0.0"
   },
   {
      "type": "git-repository",
      "parentDirectory": "~/projects",
      "repositories": [
         "git@github.com:myorg/frontend.git",
         "git@github.com:myorg/backend.git"
      ]
   },
   {
      "type": "vscode"
   },
   {
      "type": "docker"
   }
]

[
   {
      "type": "pyenv",
      "pythonVersions": ["3.11.0", "3.10.0"],
      "global": "3.11.0"
   },
   {
      "type": "pip",
      "install": ["pandas", "numpy", "matplotlib", "scikit-learn"]
   },
   {
      "type": "venv-project",
      "envDir": ".venv",
      "cwd": "~/data-science",
      "automaticallyInstallRequirementsTxt": true
   }
]

[
   {
      "type": "homebrew",
      "formulae": ["kubernetes-cli", "helm"]
   },
   { "type": "aws-cli" },
   {
      "type": "aws-profile",
      "profile": "production",
      "awsAccessKeyId": "AKIA...",
      "awsSecretAccessKey": "TOP_SECRET"
   },
   {
      "type": "docker"
   },
   {
      "type": "ssh-key",
      "passphrase": ""
   },
   {
      "type": "terraform"
   }
]

[
   {
      "type": "aliases",
      "aliases": [
         { "alias": "g", "value": "git" },
         { "alias": "d", "value": "docker" },
         { "alias": "k", "value": "kubectl" },
         { "alias": "tf", "value": "terraform" }
      ]
   },
   {
      "type": "path",
      "paths": [
         "$HOME/.local/bin",
         "$HOME/scripts"
      ]
   }
]

Define your desired system state and let Codify handle the implementation details.

Run codify apply as many times as you want - Codify only makes necessary changes.

Codify tracks what it manages, allowing for clean modifications and removals.

Most resources work on both macOS and Linux, with automatic OS detection.

Each resource is independent and can declare dependencies on others.

Modify your configuration file and Codify will compute the minimal set of changes needed.

Codify only manages what you explicitly declare. Other system state is ignored.

{
  "type": "aliases",
  "aliases": [
    { "alias": "ll", "value": "ls -la" }
  ],
  "declarationsOnly": true
}

Codify manages the complete state of a resource and tracks all changes.

{
  "type": "homebrew",
  "formulae": ["git", "node"]
}

If you remove "node" from the config, Codify will uninstall it.

• Node.js >= 18.0.0
• TypeScript
• macOS or Linux

# Clone the repository
git clone https://github.com/kevinwang5658/codify-homebrew-plugin.git
cd codify-homebrew-plugin

# Install dependencies
npm install

# Build the plugin
npm run build

# Run all tests
npm test

# Run unit tests only (fast)
npm run test:unit

# Run integration tests only (slow, requires system access)
npm run test:integration

# Run a specific test
npx vitest test/shell/alias.test.ts

src/
├── index.ts                    # Plugin entry point
├── resources/                  # Resource implementations
│   ├── homebrew/              # Homebrew package manager
│   ├── git/                   # Git resources
│   ├── shell/                 # Shell configuration
│   ├── python/                # Python tooling
│   └── ...                    # 50+ other resources
└── utils/                     # Shared utilities

test/                          # Integration tests
scripts/                       # Build and deployment scripts

We welcome contributions! Here's how to get started:

1. Create a new directory: src/resources/category/resource-name/
2. Create the resource class extending Resource<ConfigType>
3. Implement required lifecycle methods:
   • getSettings() - Define schema and configuration
   • refresh() - Read current system state
   • create() - Create the resource
   • modify() - Modify existing resource (optional)
   • destroy() - Remove the resource
4. Register your resource in src/index.ts
5. Add integration tests in test/
6. Submit a pull request

• Use TypeScript strict mode
• Write tests for new resources (both unit and integration)
• Follow existing code patterns
• Use Zod schemas for new resources (preferred over JSON Schema)
• Handle both macOS and Linux where applicable
• Update documentation

Integration tests run against your actual system, so:

• Tests create and destroy real resources
• Use test accounts/directories when possible
• The test framework saves and restores shell configuration
• Some tests require specific tools (Xcode on macOS, etc.)

This plugin uses a Resource-based architecture:

• Each resource extends Resource<ConfigType> from @codifycli/plugin-core
• Resources implement a standard lifecycle: refresh → create/modify/destroy
• The framework handles state tracking, planning, and execution
• Resources can declare dependencies and OS compatibility
• Parameters can be simple, array-based, or fully stateful

For detailed architecture documentation, see CLAUDE.md.

# Build for production
npm run build

# Deploy to registry (maintainers only)
npm run deploy

# Deploy beta version
npm run deploy:beta

The build process:

1. Compiles TypeScript with Rollup
2. Queries all resources for their schemas
3. Generates dist/schemas.json for validation
4. Bundles into a single distributable file

ISC License - see LICENSE file for details.

• Main Site - Official website
• Codify CLI - Main CLI tool
• Plugin Core - Plugin framework
• Documentation - Full documentation

• Open an issue for bug reports
• Submit pull requests for contributions
• Star the project if you find it useful!

Made with ❤️ by the Codify community