docs: add comprehensive documentation for codeflash-cc-plugin#1857
docs: add comprehensive documentation for codeflash-cc-plugin#1857
Conversation
Six documents covering getting started, usage, configuration, architecture, hook lifecycle, and troubleshooting for the Claude Code plugin. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move docs into claude-code-plugin/ subdirectory as .mdx files with Mintlify frontmatter (title, description, icon, sidebarTitle). Add Claude Code Plugin group to docs.json navigation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
there are stale files which aren't referred anywhere in the documentation |
| - **Claude Code** v2.1.38 or later | ||
| - **Python projects**: [codeflash](https://pypi.org/project/codeflash/) installed in a virtual environment | ||
| - **JS/TS projects**: [codeflash](https://www.npmjs.com/package/codeflash) installed as a dev dependency | ||
|
|
There was a problem hiding this comment.
Are we not supporting Java projects through this?
There was a problem hiding this comment.
it didn't work super well up till now for java. we should release support for java in the future
| ### Add the marketplace and install | ||
|
|
||
| ```bash | ||
| /plugin marketplace add codeflash-ai/codeflash-cc-plugin |
There was a problem hiding this comment.
These need to be ran one by one
I think claude doesnt support adding cmds together for its config changes.
ANd usually copy button is given to copy the cmds together.
|
|
||
| Or from a local clone: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
We can keep this as compressed under accordian.
There was a problem hiding this comment.
removing it actually
| 5. It runs `codeflash --subagent` in the background with a 10-minute timeout | ||
| 6. Results are reported when optimization completes | ||
|
|
||
| You can continue working while codeflash optimizes in the background. |
There was a problem hiding this comment.
Does this /optimize also invokes codeflash as background task?
There was a problem hiding this comment.
yes that is corrcet
|
|
||
| I need to install and configure Codeflash for my project to enable AI-powered performance optimization. | ||
|
|
||
| ## Objective |
There was a problem hiding this comment.
@aseembits93 This was added for agents to read about codeflash fast and was based on mintlify docs.
There was a problem hiding this comment.
https://www.mintlify.com/docs/ai-native#ai-native-documentation
They might have changed now but we must have this as a support to agents to be able to install and know how to configure codeflash.
There was a problem hiding this comment.
ok i can restore this one, i couldn't find it referred anywhere that's why i thought it was redundant
2 participants
Summary
agents/optimizer.md,scripts/suggest-optimize.sh,skills/optimize/SKILL.md,commands/setup.md,hooks/hooks.json, manifests)Test plan
🤖 Generated with Claude Code