About acestep-docs
acestep-docs is a documentation skill for users and developers of the ACE-Step music generation system. It directs readers to guides for setup, operation, hardware configuration, inference, and APIs.
Key features
- 01Topic-based document routing
- 02Installation and startup guidance
- 03Web UI usage guide
- 04Inference parameter tuning resources
- 05Hardware and environment setup guides
- 06REST API references
Use cases
- 01Find ACE-Step installation steps
- 02Address GPU memory configuration issues
- 03Tune music generation inference parameters
- 04Develop with or call the APIs
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ ace-step/ ace-step-1.5 --skill acestep-docsAfter installing, type/acestep-docsin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
api/API.mdOpenrouter_API.mdgetting-started/ABOUT.mdREADME.mdTutorial.mdguides/ENVIRONMENT_SETUP.mdGPU_COMPATIBILITY.mdGRADIO_GUIDE.mdINFERENCE.mdSCRIPT_CONFIGURATION.mdUPDATE_AND_BACKUP.mdDetails
From the project READMEACE-Step Documentation
Documentation skill for ACE-Step music generation system.
Quick Reference
Getting Started
| Document | Description |
|---|---|
| README.md | Installation, model download, startup commands |
| Tutorial.md | Getting started tutorial, best practices |
| ABOUT.md | Project overview, architecture, model zoo |
Guides
| Document | Description |
|---|---|
| GRADIO_GUIDE.md | Web UI usage guide |
| INFERENCE.md | Inference parameters tuning |
| GPU_COMPATIBILITY.md | GPU/VRAM configuration, hardware recommendations |
| ENVIRONMENT_SETUP.md | Environment detection, uv installation, python_embeded setup (Windows/Linux/macOS) |
| SCRIPT_CONFIGURATION.md | Configuring launch scripts: .bat (Windows) and .sh (Linux/macOS) |
| UPDATE_AND_BACKUP.md | Git updates, file backup, conflict resolution (all platforms) |
API (for developers)
| Document | Description |
|---|---|
| API.md | REST API documentation |
| Openrouter_API.md | OpenRouter API integration |
Instructions
- Installation questions → read getting-started/README.md
- General usage / best practices → read getting-started/Tutorial.md
- Project overview / architecture → read getting-started/ABOUT.md
- Web UI questions → read guides/GRADIO_GUIDE.md
- Inference parameter tuning → read guides/INFERENCE.md
- GPU/VRAM issues → read guides/GPU_COMPATIBILITY.md
- Environment setup (uv, python_embeded) → read guides/ENVIRONMENT_SETUP.md
- Launch script configuration (.bat/.sh) → read guides/SCRIPT_CONFIGURATION.md
- Updates and backup → read guides/UPDATE_AND_BACKUP.md
- API development → read api/API.md or api/Openrouter_API.md
Common Issues
- Installation problems: See getting-started/README.md
- VRAM insufficient: See guides/GPU_COMPATIBILITY.md
- Model download failed: See getting-started/README.md or guides/SCRIPT_CONFIGURATION.md
- uv not found: See guides/ENVIRONMENT_SETUP.md
- Environment detection issues: See guides/ENVIRONMENT_SETUP.md
- BAT/SH script configuration: See guides/SCRIPT_CONFIGURATION.md
- Update and backup: See guides/UPDATE_AND_BACKUP.md
- Update conflicts: See guides/UPDATE_AND_BACKUP.md
- Inference quality issues: See guides/INFERENCE.md
- Gradio UI not starting: See guides/GRADIO_GUIDE.md
Comments
Markdown supported