# `ok`

The `ok` tool helps you to create a fresh Terraform environment (like prod or development) and configure it to use remote state storage. `ok` is created and maintained by team Utviklerflyt. You can [take a look at the repository here](https://github.com/oslokommune/ok?tab=readme-ov-file#homebrew){:target="_blank"}.

Your environment is configured using a `packages.yml` file. This file is a package manifest listing the components from Golden Path that you want to use.
An example can be found in the [`pirates-iac` repository](https://github.com/oslokommune/pirates-iac/blob/main/stacks/dev/packages.yml){:target="_blank"}.

<figure markdown>
  ![otters-books-small](https://user-images.githubusercontent.com/1691190/229563621-2ffb9ea8-bffd-49e2-86e9-1885eef22f4d.svg){ width="400" }
</figure>

| Command         | Description                                                                                                                                                                                             | Requires Boilerplate |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------: |
| `ok aws`        | Do AWS stuff                                                                                                                                                                                            |                      |
| `ok completion` | Generate the autocompletion script for the specified shell                                                                                                                                              |                      |
| `ok forward`    | Starts a port forwarding session to a database. [See "Connect to a database from your computer".](../database/connect-to-a-database-from-your-computer.md#step-3-connect-to-database){:target="_blank"} |                      |
| `ok help`       | Help about any command                                                                                                                                                                                  |                      |
| `ok pkg`        | Manage Boilerplate packages                                                                                                                                                                             |  :heavy_check_mark:  |
| `ok version`    | Prints the version of the `ok` tool.                                                                                                                                                                    |                      |