Quick Start Guide to Codex

The fastest way to get into Codex

Quick Install Guide using a test Codex Open Source Repo

This guide will help you get Codex setup on your device. We will go over adding Codex to VSCode and joining a Codex on an open source repository.

  1. Start by installing the extension from the VSCode Marketplace or the JetBrains Marketplace
  1. Clone our open-source repository to your local device: link
    1. You can use the following command when you are in the folder you want to place the root directory: git clone https://github.com/usecodex/codex-demo.git
  1. Once you have cloned the repo locally, open it at root in VsCode.
  1. Open the file file_with_examples.js to see example pieces of Context, if you’d like you can:
    1. Test using an @mention to brandon, that’s the CEO, and he loves getting messages in Codex
    2. Test adding context by highlighting code then hit ctrl+shift+s (or click the context + banner) and you’ll be adding context

Also try the detailed start guide with videos if you want to go more in depth!

Here’s an example of what you’ll see in the demo open source repo, click on any highlighted code blocks to see the context.

Notion image

Slack App Install guide

  1. In Slack create a channel called codex-log; our app currently reports only to a channel with this name
  1. 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
  1. You’ll be taken to the Slack page to confirm connecting Codex to your slack - confirm
  1. You’ll be brought to a basic success page that will then open Slack
  1. In Slack you will need to connect to the channel you created called codex-log
  1. 🎉 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” link to be taken directly into the file at the line of the code block (as long as the repository is present on the local machine)

Example output to Slack:

Notion image
Did this answer your question?