Autoschematic

The recommended method of installing Autoschematic is with pip:

pip install autoschematic

This will install a pre-built binary for your platform. If you prefer to compile from source, or through cargo install, see the GitHub repo for instructions.

There's also an extension available for Visual Studio Code. We highly recommend this extension if you use Visual Studio Code. It allows you to diff and import resources against remote state, and make use of the language server and other useful integrations.

Raise an issue on Github if you'd like the extension ported to your preferred editor! The core uses the standard LSP protocol and should be easy to adapt.

Once you have Autoschematic installed, verify it by running autoschematic at the command line. You should see the standard help listing as below:

Usage: autoschematic <COMMAND>

Commands:
  init      Create an Autoschematic config if not already present
  safety    Set or unset the safety lock file. When set, the safety lock prevents any operations that would modify infrastructure (Executing ConnectorOps or Tasks)
  validate  Validate that the Autoschematic config within this repository is well-formed. Includes autoschematic.lock.ron and autoschematic.rbac.ron if present
  install   Install or upgrade the connectors listed in autoschematic.ron
  seal      Seal a secret against a server's public key
  plan      Display the series of operations needed to apply the changeset
  apply     Execute the series of operations needed to apply the changeset
  unbundle  Unpack bundle files to produce or refresh their children
  run-task  Execute a workflow task as defined by a connector
  import    Import remote resources into the repository
  create    Scaffold new resource definitions from templates
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

These commands will all be covered in guides like this one. Move on to the next section, "Create and Configure a Repo", to continue.

Alternatively, you can skip to 'Manage Infra with Connectors' if you'd rather dive in.

Next: Create and Configure a Repo