From aecfe96010576208d8e4400426886debddb2c050 Mon Sep 17 00:00:00 2001 From: hopeatina Date: Sat, 9 May 2026 10:38:19 -0500 Subject: [PATCH] chore: add Codex environment setup --- .codex/README.md | 30 ++++++++++++++++++++++++++++++ .codex/cleanup-local-worktree.sh | 10 ++++++++++ .codex/maintenance-cloud.sh | 10 ++++++++++ .codex/setup-cloud.sh | 17 +++++++++++++++++ .codex/setup-local-worktree.sh | 10 ++++++++++ AGENTS.md | 31 +++++++++++++++++++++++++++++++ 6 files changed, 108 insertions(+) create mode 100644 .codex/README.md create mode 100755 .codex/cleanup-local-worktree.sh create mode 100755 .codex/maintenance-cloud.sh create mode 100755 .codex/setup-cloud.sh create mode 100755 .codex/setup-local-worktree.sh create mode 100644 AGENTS.md diff --git a/.codex/README.md b/.codex/README.md new file mode 100644 index 0000000..62262c1 --- /dev/null +++ b/.codex/README.md @@ -0,0 +1,30 @@ +# Codex Cloud Environment + +Use these repo-local scripts when configuring the Codex cloud environment for `useorgx/orgx-opencode-plugin`. + +## Setup script + +```bash +bash .codex/setup-cloud.sh +``` + +## Maintenance script + +```bash +bash .codex/maintenance-cloud.sh +``` + +## Environment notes + +- Node 22 or newer is safe for this repository. +- The package depends on `useorgx/orgx-gateway-sdk`; dependency install needs GitHub access during setup. +- Live OpenCode daemon checks require a local OpenCode session and should not be treated as Codex cloud setup checks. +- Keep internet access limited to the setup phase unless a task explicitly needs external services. + +## Verification commands + +```bash +npm run type-check +npm test +npm run build +``` diff --git a/.codex/cleanup-local-worktree.sh b/.codex/cleanup-local-worktree.sh new file mode 100755 index 0000000..1404250 --- /dev/null +++ b/.codex/cleanup-local-worktree.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +set -euo pipefail + +cd "${CODEX_WORKTREE_PATH:-$(dirname "${BASH_SOURCE[0]}")/..}" + +if [ -f docker-compose.yml ] || [ -f docker-compose.yaml ] || [ -f compose.yml ] || [ -f compose.yaml ]; then + docker compose down --remove-orphans 2>/dev/null || true +fi + +rm -rf .cache/tmp .next/cache .turbo .vitest .wrangler/tmp node_modules/.cache tmp diff --git a/.codex/maintenance-cloud.sh b/.codex/maintenance-cloud.sh new file mode 100755 index 0000000..521b9ef --- /dev/null +++ b/.codex/maintenance-cloud.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +set -euo pipefail + +cd "$(dirname "${BASH_SOURCE[0]}")/.." + +export CI=1 +export npm_config_audit=false +export npm_config_fund=false + +npm install --package-lock=false diff --git a/.codex/setup-cloud.sh b/.codex/setup-cloud.sh new file mode 100755 index 0000000..7344c12 --- /dev/null +++ b/.codex/setup-cloud.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash +set -euo pipefail + +cd "$(dirname "${BASH_SOURCE[0]}")/.." + +export CI=1 +export npm_config_audit=false +export npm_config_fund=false + +node --version +npm --version + +# This repo intentionally has no lockfile. Avoid creating one in Codex setup. +npm install --package-lock=false +npm run type-check +npm test +npm run build diff --git a/.codex/setup-local-worktree.sh b/.codex/setup-local-worktree.sh new file mode 100755 index 0000000..ada8e39 --- /dev/null +++ b/.codex/setup-local-worktree.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +set -euo pipefail + +cd "${CODEX_WORKTREE_PATH:-$(dirname "${BASH_SOURCE[0]}")/..}" + +if [ -x .codex/maintenance-cloud.sh ]; then + bash .codex/maintenance-cloud.sh +else + echo "No .codex/maintenance-cloud.sh found; skipping local worktree setup." +fi diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..48d3df5 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,31 @@ +# AGENTS.md + +Guidelines for Codex and other agents working in `useorgx/orgx-opencode-plugin`. + +## Project + +This repo is the OpenCode peer plugin for OrgX Gateway Protocol v1 and passive Work Graph reconciliation. + +## Setup + +For Codex cloud, use: + +```bash +bash .codex/setup-cloud.sh +``` + +Maintenance script for cached environments: + +```bash +bash .codex/maintenance-cloud.sh +``` + +## Verification + +```bash +npm run type-check +npm test +npm run build +``` + +Do not treat local OpenCode daemon availability as a cloud setup requirement. Mock or isolate daemon-dependent behavior unless the task specifically asks for local integration testing.