feat(new-plugin): suno music generation

[Freytes]

@elizaos/plugin-suno

A Suno AI music generation plugin for ElizaOS that enables AI-powered music creation and audio manipulation.

Overview

The Suno plugin integrates Suno AI's powerful music generation capabilities into ElizaOS, providing a seamless way to:

• Generate music from text prompts
• Create custom music with fine-tuned parameters
• Extend existing audio tracks

Original Plugin Source (adapted for Eliza): https://github.com/gcui-art/suno-api?tab=readme-ov-file

Installation

npm install @elizaos/plugin-suno

Quick Start

1. Register the plugin with ElizaOS:

import { sunoPlugin } from '@elizaos/plugin-suno';
import { Eliza } from '@elizaos/eliza';

const eliza = new Eliza();
eliza.registerPlugin(sunoPlugin);

2. Configure the Suno provider with your API credentials:

import { sunoProvider } from '@elizaos/plugin-suno';

sunoProvider.configure({
  apiKey: 'your-suno-api-key'
});

Features

1. Generate Music

Generate music using predefined settings and a text prompt:

await eliza.execute('suno.generate', {
  prompt: "An upbeat electronic dance track with energetic beats"
});

2. Custom Music Generation

Create music with detailed control over generation parameters:

await eliza.execute('suno.customGenerate', {
  prompt: "A melodic piano piece with soft strings",
  temperature: 0.8,
  duration: 30
});

3. Extend Audio

Extend existing audio tracks to create longer compositions:

await eliza.execute('suno.extend', {
  audioFile: "path/to/audio.mp3",
  duration: 60
});

API Reference

SunoProvider Configuration

The Suno provider accepts the following configuration options:

interface SunoConfig {
  apiKey: string;
}

Action Parameters:

1. Generate Music

interface GenerateMusicParams {
  prompt: string;
}

2. Custom Generate Music

interface CustomGenerateMusicParams {
  prompt: string;
  temperature?: number;
  duration?: number;
}

3. Extend Audio

interface ExtendAudioParams {
  audioFile: string;
  duration: number;
}

Error Handling

The plugin includes built-in error handling for common scenarios:

try {
  await eliza.execute('suno.generate', params);
} catch (error) {
  if (error.code === 'SUNO_API_ERROR') {
    // Handle API-specific errors
  }
  // Handle other errors
}

Examples

Creating a Complete Song:

const result = await eliza.execute('suno.generate', {
  prompt: "Create a pop song with vocals, drums, and guitar",
  duration: 180  // 3 minutes
});

console.log(`Generated music file: ${result.outputPath}`);

Extending an Existing Track:

const extended = await eliza.execute('suno.extend', {
  audioFile: "original-track.mp3",
  duration: 60  // Add 60 seconds
});

console.log(`Extended audio file: ${extended.outputPath}`);

License

MIT

---

Built with ❤️ for ElizaOS

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.