<aside> 💡 Find our up to date guides here: https://support.usecodex.com/getting-started/w2ydfN4CuMxpgi5t7DnJJb/quick-start-guide-to-codex/usycz8YHhrCKSjpRHCvNvV

</aside>

Quick Start Guide to Codex

Quick Install Guide with a Codex Open Source Repo:

This guide will help you get things setup on your device. We will go over adding Codex to VsCode and creating a Codex on a repository.

  1. Start by installing the extension from the VSCode Marketplace: https://marketplace.visualstudio.com/items?itemName=CodexBuild.codex-build&ssr=false#overview
  2. Clone our open-source repository to your local device: ‣
  3. You can use the following command when you are in the right folder: git clone [<https://github.com/usecodex/codex-demo.git>](<https://github.com/usecodex/codex-demo.git>)
  4. Once you have cloned the repo locally, open this folder in VsCode.
  5. Open the file file_with_examples.js to see example pieces of Context or Questions.

Detailed Install Guide 🗒️

Slack App Install guide

  1. In slack create a channel called codex-log our app currently reports only to a channel with this name
  2. Open VSCode and go to the Codex extension. At the bottom click select codices - you must be the admin of the codex you wish to connect to slack. Click the slack icon to start connecting Codex to Slack
  3. You’ll be taken to the Slack page to confirm connecting Codex to your slack - confirm
  4. You’ll be brought to a basic success page that will then open Slack
  5. In slack you will need to connect to the channel you created called codex-log
  6. 🎉 You’re done! Now when someone creates context in Codex it will be reported into the slack channel and your team can click the handy ‘open in VSCode’ to be taken directly into the file at the line of the code block (as long as they have the repo on local)

Example output to slack:

Untitled