Handbook contents

Field guide · 1~10 min

Set up your development environment

Choose Windows, macOS or Codespaces and follow the setup path for that environment.

Before you start

Choose your setup path

The project supports managed Windows laptops, macOS and GitHub Codespaces. Choose the environment you will use to see its folder, clone, workspace and credential instructions.

Choose your development environment

What device are you using?

Choose a device to see the correct setup path.

Configure commit signing

Every commit must be signed. The setup differs between local devices and Codespaces, so choose the environment you are using.

Generate your commands

Enter the name and email attached to your GitHub account. These values stay on this page and are only used to build the script below.

Copy the complete script and paste it into PowerShell. At the ssh-keygen questions, press Enter to accept the default key location and choose a passphrase. The remaining commands then continue automatically.

Enter your name and GitHub email to generate the PowerShell script.

When the script finishes, your public key is on the clipboard. Add it under GitHub Settings → SSH and GPG keys → New SSH key, and change the key type from Authentication Key to Signing Key. Open a fresh workspace terminal afterwards; the bootstrap should report [OK] Commit signing configured.

Prove it works

dbt debug
dbt show -s stg_csds_bridging

dbt debug should end with All checks passed!. The second command is a useful final check that you can compile a project model and query the development environment.

If setup fails

  • Connection or role error: check .env for a local setup, or your repository-scoped Codespaces secrets for the cloud route.
  • Authentication does not start: local setup normally uses browser SSO. Codespaces cannot use that redirect and requires a Snowflake PAT.
  • Tooling is missing: locally, reopen the named workspace and create a fresh terminal. In Codespaces, rebuild the container from the command palette so the post-create setup runs again.
  • PowerShell blocks the setup script: run the CurrentUser execution-policy command shown in the Windows route. If corporate policy still blocks it, ask your team or IT support.
  • Access denied: this is usually an access request, not a local code fix. Send the exact account, role and error to your team lead.