Skip to content

Commit 468b807

Browse files
committed
Update README.md
1 parent 5e3866b commit 468b807

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@
44
55
## Overview
66

7-
Codex KKP is a Kotlin-based Claude Code Skills Plugin that enables seamless integration with Codex AI Agent for code
8-
analysis, implementation, and collaboration tasks.
7+
Codex KKP is a Claude Code Plugin that enables seamless integration with Codex AI Agent for code
8+
analysis, implementation, and collaboration tasks. Provides a subagent and a skill for Codex AI Agent.
99

1010
## Features
1111

1212
- **Multi-platform Support**: Native binaries for macOS, Linux, and Windows
1313
- **Streamlined results**: By default, only completed results are returned to reduce token consumption.
1414
- **Sandbox Modes**: Configurable security levels (read-only, workspace-write, danger-full-access)
1515
- **Session Management**: Resume previous sessions and maintain context
16+
- **Claude Code Subagents**: Run subagents in parallel to improve performance
1617
- **Sugar-Free, Calorie-Free**: Very healthy
1718

1819
## Installation
@@ -24,7 +25,7 @@ analysis, implementation, and collaboration tasks.
2425
**1.1 Download source**
2526

2627
[Download](https://github.com/ForteScarlet/codex-kkp/archive/refs/heads/plugins/release.zip)
27-
the source code for Branch `plugins/release` and extract it,
28+
the source code for Branch `plugins/release` and extract it,
2829

2930
**1.2 Clone source**
3031

@@ -44,6 +45,7 @@ claude
4445
```
4546

4647
Use `/plugin`:
48+
4749
```
4850
/plugin
4951
```
@@ -70,6 +72,7 @@ You can download and unzip it, then place the extracted directory in your skills
7072
(e.g., `<PROJECT_DIR>/.claude/skills/codex-agent-collaboration/`).
7173

7274
This single ZIP file includes executables for all supported platforms:
75+
7376
- macOS x86_64 (Intel) - `executables/codex-kkp-cli-macosx64`
7477
- macOS ARM64 (Apple Silicon) - `executables/codex-kkp-cli-macosarm64`
7578
- Linux x86_64 - `executables/codex-kkp-cli-linuxx64`
@@ -88,13 +91,14 @@ Note: All executables use uniform naming without file extensions (including Wind
8891

8992
### Tool installation and management
9093

91-
Some open-source projects may allow independent management of marketplaces
92-
and skills through repository addresses and branches (e.g., [cc-switch](https://github.com/farion1231/cc-switch), skills only).
94+
Some open-source projects may allow independent management of marketplaces
95+
and skills through repository addresses and branches (e.g., [cc-switch](https://github.com/farion1231/cc-switch), skills
96+
only).
9397
You can also configure skills directly based on repositories and branches using these tools.
9498

9599
## Configuration
96100

97-
Once you've finished installing the plugin,
101+
Once you've finished installing the plugin,
98102
you can proceed to configure some of your settings in advance.
99103

100104
Edit the `.claude/settings.local.json` file in your project
@@ -126,8 +130,9 @@ and add the following configuration to property `permissions.allow`:
126130
}
127131
```
128132

129-
> If loading locally, then `~/.claude/marketplace/` should be replaced with the directory of your locally downloaded `codex-kkp-skills-marketplace`.
133+
> If loading locally, then `~/.claude/marketplace/` should be replaced with the directory of your locally downloaded
134+
`codex-kkp-skills-marketplace`.
130135

131-
In `Bash`, the path refers to the executable file within the installed plugin package
136+
In `Bash`, the path refers to the executable file within the installed plugin package
132137
that corresponds to your system platform.
133138
You may need to make slight adjustments based on the actual situation.

0 commit comments

Comments
 (0)