Rule Books

Rule Books are how you teach Stakpak to follow your way of doing things. Think of them as smart, markdown based SOPs (standard operating procedures), whether it’s how to deploy to production, upgrade infrastructure, or tag resources correctly. Stakpak uses Rule Books to make decisions that align with your team’s standards, not just generic best practices.

There are two types of rule books:

Note:

  • You can view and create your rule books at stakpak.dev

  • You can disable the official rule books by opening your terminal and writing stakpak --disable-official-rulebooks

How to Enable/Disable Rule Books?

Enable/Disable Rule Books for a Single Session

  1. Open stakpak

  2. Press CTRL+K

  3. Use the ARROWS to move

  4. Press SPACE to select/unselect rule books

  5. Press ENTER to confirm

Enabling/Disabling Rule Books Across Your Entire Account

  1. Open your terminal and type stakpak config sample

  2. Here you can view everything you can edit

  1. Then use your favorite editor to edit ~/.stakpak/config.toml

  2. Then include/exclude the rule books you want

Last updated