Codify

Installation

Installation Methods

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

This command-line installation method works for both arm64 and x64 architectures and supports most POSIX-compliant shells on macOS, Linux, and Windows (WSL).

The installation script will request sudo privileges to complete the installation.

macOS:

Linux:

For a portable installation, download the tarball for Codify and extract it. You will need to manually add the executable ($TARBALL_LOCATION/bin/codify.sh) to your PATH to run Codify from anywhere on your system.

macOS:

Download the pre-packaged installer, run it, and follow the on-screen instructions to install Codify.

Verify Installation

If the installation was successful, you should see output similar to this:

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

Web Editor

Checkout the Codify Editor. From there you can manage your configurations, run Codify commands, and collaborate with team members. The editor features both a drag-and-drop block interface and a code editor with auto-completion. It is the recommended way to get started with creating Codify configurations.

Enable local codify.jsonc Auto-Completion

Enable auto-completion and syntax validation in your favourite editor / IDE for codify.jsonc files.

Auto-completion and validation for codify.jsonc files work automatically without additional setup.

This applies to all JetBrains-based IDEs including IntelliJ IDEA, WebStorm, PhpStorm, PyCharm, CLion, Android Studio, and others.

JSON auto-completion in JetBrains IDEs has several unresolved bugs (see here and here) which may cause additional properties to be suggested even when they're not valid for the configuration. The validation system should catch these and highlight them as errors.

To enable auto-completion in VS Code:

To enable auto-completion in Sublime Text:

Instructions:

  1. Open the command palette and run Package Control: Install Package, then select LSP
  2. Install LSP-yaml or LSP-json from Package Control
  3. Restart Sublime Text

To enable auto-completion in Emacs:

Install eglot.

To enable auto-completion in Neovim:

Install SchemaStore.nvim

For other editors and custom use cases, the JSON schema for Codify and the core plugin can be found here: https://raw.githubusercontent.com/codifycli/codify-schemas/main/src/schemastore/codify-schema.json

Load this schema in any JSON Schema-compatible editor to enable auto-completion and validation. This file is regularly updated with new resources and changes.

Uninstalling Codify

To fully uninstall Codify. Run the following command:

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

On this page