Skip to content
Codify

Installation

Methods

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

CLI installation method. Run the command in your terminal to fully install Codify. This command works for both arm64 and x64 architectures. Currently only MacOS is supported.

Verify installation

If the installation was successful you should see:

terminal
> codify --version
codify/0.7.0 darwin-arm64 node-v20.15.0

Getting started

Let’s get started with your first codify.json config.

  1. Run codify init and follow the instructions to generate a codify.json file with your installed programs and settings.
terminal
> codify init


 █▀▀ █▀█ █▀▄ █ █▀▀ █▄█
 █▄▄ █▄█ █▄▀ █ █▀   █




Codify is a configuration-as-code tool that helps you setup and manage your system.
Use this init flow to get started quickly with Codify.


Codify will scan your system for any supported programs or settings and automatically generate configs for you.
❯ Continue
  1. Verify that the config works by running codify apply in the same directory as the newly generated Codify file (defaults to ~/codify.json). Since the config was generated based on existing tools and settings no changes should be reported back.
terminal
╭────────────────────────────────────────────────╮
│Codify Plan                                     │
╰────────────────────────────────────────────────╯
Path: /Users/kevinwang/Projects/codify/codify.json
The following actions will be performed:


No changes necessary. Exiting
  1. And that’s it! Note that Codify can only import tools and settings it currently supports. If there is a tool that you’d like to request support for, you can do so from our support page.

Creating your own configs

Now, let’s create a new custom codify.json and install a new tool. In this example we will be installing jq via homebrew.

  1. Create a codify.json file in any directory.
terminal
touch codify.json
  1. Open the file with your favourite text editor and add the following configs
~/codify.json
[
  {
    "type": "homebrew",
    "formulae": ["jq"]
  }
]
  1. Run codify apply to generate a plan.
terminal
codify apply
  1. Codify will now plan out the installations needed to ensure that homebrew and the homebrew formula jq is installed. More information about the homebrew resource here. The plan may vary depending on what’s already been installed on the computer.
terminal
╭───────────────────────────────────────╮
│Codify Plan                            │
╰───────────────────────────────────────╯
The following actions will be performed:


 ~ homebrew will be modified
  {
 ~    "formulae": [
 +        jq,
      ],
  }


Do you want to apply the above changes?
❯ Yes
  No
  1. Respond yes to apply the changes. Open a new terminal tab or source your startup script to use the newly installed packages.

Enable codify.json auto-completion

Enable auto-completion and syntax checking in your favourite editors for codify.json files.

Autocompletion and validation for codify.json files work automatically without additional installations.

This applies to all Jetbrains based IDEs such as Intellij IDEA, Webstorm, Phpstorm, Pycharm, CLion, Android Studios, and etc…