Skip to content

INSTALLATION.md

Latest commit

 

History

History
72 lines (46 loc) · 3.93 KB

INSTALLATION.md

File metadata and controls

72 lines (46 loc) · 3.93 KB
Raw

Installation

Product syntax

  • ChatGPT desktop: type @ and select a skill.
  • Codex CLI or IDE: type $ to mention a skill, or use /skills.

Native Plan may appear as a host collaboration mode rather than an @plan or $plan skill. Use the host's Plan control when available; otherwise invoke the portable @standard-plan / $standard-plan fallback included in this bundle.

Repository-scoped use

Clone without checking out the mutable default branch, then switch directly to the reviewed source commit:

git clone --no-checkout https://github.com/Mohammed-Moniem/codex-engineering-system.git
cd codex-engineering-system
git switch --detach 082ed4c3134d315fe76cdafff1fe25f3f9daca96
codex

Codex scans .agents/skills from the working directory to the repository root. The pinned commit is the reviewed executable/package state for this release; use the default branch only when you deliberately want the current development version.

Individual skills

Ask the built-in $skill-installer to install a GitHub repository subpath pinned to the reviewed commit, for example:

$skill-installer Install the wayfinder skill from
https://github.com/Mohammed-Moniem/codex-engineering-system/tree/082ed4c3134d315fe76cdafff1fe25f3f9daca96/skills/wayfinder

Individual skill directories are self-contained; references, assets, and scripts do not reach outside their skill.

Whole bundle

Add this repository as a Git marketplace, then install the plugin:

codex plugin marketplace add Mohammed-Moniem/codex-engineering-system --ref 082ed4c3134d315fe76cdafff1fe25f3f9daca96
codex plugin add codex-engineering-system@codex-engineering-system

Upgrade from 0.1.0

The 0.1.0 marketplace source was pinned to an immutable commit, so replace both the installed plugin and that pinned marketplace entry:

codex plugin remove codex-engineering-system@codex-engineering-system
codex plugin marketplace remove codex-engineering-system
codex plugin marketplace add Mohammed-Moniem/codex-engineering-system --ref 082ed4c3134d315fe76cdafff1fe25f3f9daca96
codex plugin add codex-engineering-system@codex-engineering-system

After an install or upgrade, fully restart ChatGPT desktop or Codex Desktop and begin a new task. For the CLI or IDE, start a new session. An already-running task does not reload its skill catalog.

If a skill is registered but absent from autocomplete

Use /skills in a fresh task to inspect the active catalog. Codex has a bounded skill-description context budget; a host with many enabled plugins and user skills can omit later entries even when their plugin package is valid. Disable unused plugins or install the needed skill individually if the catalog reports a budget overflow. This bundle keeps descriptions concise, but it cannot enlarge the host budget or force an omitted entry into autocomplete.

For a local clone under review, substitute the clone's path in the first command. There are three supported paths:

  1. Clone the repository and use its repo-scoped skills immediately.
  2. Add the Git or local marketplace and install the included skills-only plugin.
  3. Submit the plugin through the current Codex universal-directory workflow.

The marketplace and plugin manifests are ready for local validation and future universal-directory submission. This repository does not claim that a public GitHub URL by itself is a universal plugin-directory listing. Follow the current OpenAI plugin packaging documentation for local marketplace testing and submission.

Codex supports symlinked skill folders. Advanced users may link selected directories from skills/ into their user skill directory, but should review the exact source before doing so.

Hooks

Installed plugin hooks require explicit trust. Use /hooks to inspect their source and current hash. The skills work without the hooks; session recovery then requires manually opening .codex/wayfinder/ACTIVE.