mcpField
A
acestep-docs

acestep-docs

github.com/ace-stepDevelopment14.1k69 installsUpdated 9w ago
Repository

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

  1. 01Topic-based document routing
  2. 02Installation and startup guidance
  3. 03Web UI usage guide
  4. 04Inference parameter tuning resources
  5. 05Hardware and environment setup guides
  6. 06REST API references

Use cases

  1. 01Find ACE-Step installation steps
  2. 02Address GPU memory configuration issues
  3. 03Tune music generation inference parameters
  4. 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-docs

After installing, type/acestep-docsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

api/
API.md
Openrouter_API.md
getting-started/
ABOUT.md
README.md
Tutorial.md
guides/
ENVIRONMENT_SETUP.md
GPU_COMPATIBILITY.md
GRADIO_GUIDE.md
INFERENCE.md
SCRIPT_CONFIGURATION.md
UPDATE_AND_BACKUP.md

Details

From the project README

ACE-Step Documentation

Documentation skill for ACE-Step music generation system.

Quick Reference

Getting Started
DocumentDescription
README.mdInstallation, model download, startup commands
Tutorial.mdGetting started tutorial, best practices
ABOUT.mdProject overview, architecture, model zoo
Guides
DocumentDescription
GRADIO_GUIDE.mdWeb UI usage guide
INFERENCE.mdInference parameters tuning
GPU_COMPATIBILITY.mdGPU/VRAM configuration, hardware recommendations
ENVIRONMENT_SETUP.mdEnvironment detection, uv installation, python_embeded setup (Windows/Linux/macOS)
SCRIPT_CONFIGURATION.mdConfiguring launch scripts: .bat (Windows) and .sh (Linux/macOS)
UPDATE_AND_BACKUP.mdGit updates, file backup, conflict resolution (all platforms)
API (for developers)
DocumentDescription
API.mdREST API documentation
Openrouter_API.mdOpenRouter API integration

Instructions

  1. Installation questions → read getting-started/README.md
  2. General usage / best practices → read getting-started/Tutorial.md
  3. Project overview / architecture → read getting-started/ABOUT.md
  4. Web UI questions → read guides/GRADIO_GUIDE.md
  5. Inference parameter tuning → read guides/INFERENCE.md
  6. GPU/VRAM issues → read guides/GPU_COMPATIBILITY.md
  7. Environment setup (uv, python_embeded) → read guides/ENVIRONMENT_SETUP.md
  8. Launch script configuration (.bat/.sh) → read guides/SCRIPT_CONFIGURATION.md
  9. Updates and backup → read guides/UPDATE_AND_BACKUP.md
  10. 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