Skip to content

installation.md

Latest commit

 

History

History
56 lines (37 loc) · 1.55 KB

installation.md

File metadata and controls

56 lines (37 loc) · 1.55 KB

Installation

This repo is designed as a Codex workspace and skill set, not as a source-specific plugin.

Prerequisites

  • Access to Codex
  • A local clone or copy of this repository
  • Optional: Python, browser tooling, analytics access, or SEO APIs if you plan to augment the skills with automation

Recommended Setup

  1. Clone the repository:
git clone <your-public-repo-url> codex-seo-agent

  1. Open codex-seo-agent/ as the workspace root in Codex.

  2. Keep these files together:

    • AGENTS.md
    • skills/
    • .codex/prompts/
    • docs/

  3. Start with a prompt file or invoke a skill by name in your request.

Global Skill Installation

If you prefer reusable skills outside this repo:

  1. Copy each folder in skills/ into $CODEX_HOME/skills/.
  2. If CODEX_HOME is unset, use ~/.codex/skills/.
  3. Keep AGENTS.md in the target workspace if you want the global routing and operating rules.

Prompt Usage

The files in .codex/prompts/ are reusable templates. You can:

  • ask Codex to follow a prompt file from this repo
  • paste the prompt file contents into a chat
  • adapt the template for a specific client or site

What This Repo Does Not Install

  • No source-specific plugin manifest
  • No slash-command runtime
  • No hidden background agent installers
  • No bundled API credentials or machine-specific config

Public-Release Safety Notes

  • Add credentials only in your local environment, never in the repo.
  • Do not commit generated client reports unless you intend to share them.
  • Review .gitignore before publishing updates.