Skip to content
You're viewing the v2 docs. Looking for v1?Go to v1 docs
Docs
Arcus
Popular questions
↑↓ to navigate↵ to selectesc to close
Book a demo

Codex

The Arcus plugin for the Codex CLI captures your coding sessions and sends them to QI Home, where Arcus generates test cases from them.

Prerequisites

  • The Codex CLI, with plugin support.
  • Python 3.11 or later.
  • An active Arcus project.

Install the plugin

Section titled “Install the plugin”

The plugin captures your prompts, the tools Codex runs, the files it changes, and its replies. In your terminal, run:

Terminal window
codex plugin marketplace add testsigmahq/arcus-codex-plugin
codex plugin add arcus@testsigma

You can also run /plugin inside Codex and pick arcus from the testsigma marketplace. Run codex plugin list to confirm that arcus shows as enabled.

Sign in and pick a project

Section titled “Sign in and pick a project”

  1. When Codex asks whether to trust the plugin’s hooks, accept. Capture stays off until you do.

  2. Run /arcus:login and complete the sign-in in the browser. You sign in once per machine.

  3. Run /arcus:project use <project_id> to pin the project your sessions go to.

Capture starts after you sign in. Your login token is saved in a file only you can read, ~/.arcus/refresh.token. If the optional keyring Python package is installed, the plugin also stores it in your OS keychain.

Section titled “Link your work to a ticket”

Run /arcus:map ticket <KEY> with the ticket for the work you’re doing:

Terminal window
/arcus:map ticket PROJ-123

The ticket can come from Jira, Azure DevOps, Linear, ClickUp, or GitHub. Your session then arrives in QI Home already mapped to the sprint holding that ticket, so nobody maps it manually.

Write and push test cases

Section titled “Write and push test cases”

  1. Ask Codex to write end-to-end tests for the current repository. The plugin’s test-writing skill authors them, validates them offline, and offers to run them.

  2. Ask Codex to push the test cases from this session to Arcus. Pick a sprint and module, or leave them unlinked.

For every command, see Plugins.

Where your work lands

Section titled “Where your work lands”
  • Sessions arrive on the Unlinked Contexts tab of Context Management, unless you linked a ticket. Mapping a session to a sprint or an Adhoc session triggers test generation from it.
  • Pushed test cases arrive on the Unlinked Test Cases tab, unless you picked a sprint when you pushed.

The mapping and linking steps are in Context Management.

Pull requests for the same work

Section titled “Pull requests for the same work”

With the Arcus GitHub App installed, a pull request for work you captured here joins your session automatically:

  • Session not mapped yet: the session and the pull request become a single entry in Unlinked Contexts.
  • Session already mapped: the pull request is mapped to the same sprint or Adhoc session, and there’s nothing more to do.

Was this page helpful?