# Dolphinclaw

## Docs

- [Create your Dolphinclaw account and fund your wallet](https://docs.dolphinclaw.io/account-setup.md): Create your Dolphinclaw account, fund your managed BNB wallet, and meet the requirements you need before deploying your first agent.
- [Dolphinclaw agent code structure and entry point file](https://docs.dolphinclaw.io/building/agent-structure.md): Learn what files your agent needs, how to shape the exported agent object, and which entry point the platform expects when running your code.
- [Set environment variables for your Dolphinclaw agent](https://docs.dolphinclaw.io/building/environment-variables.md): Access API keys and configuration values in your agent code using standard Node.js process.env, set securely through the DolphinClaw dashboard.
- [Use the @dolphinclaw/sdk to log and report results](https://docs.dolphinclaw.io/building/sdk.md): Install and use the official SDK to send structured logs, report milestones, and return final results that appear color-coded in the dashboard terminal.
- [Handle SIGTERM for graceful Dolphinclaw agent shutdown](https://docs.dolphinclaw.io/building/sigterm.md): Learn how to catch the SIGTERM signal in your agent, use the 10-second grace period to clean up, and safely exit long-running loops and connections.
- [Dolphinclaw agents: structure, code, and private storage](https://docs.dolphinclaw.io/concepts/agents.md): Agents are self-contained Node.js scripts with a defined structure — name, description, setup, run, and return — stored in a private Git repository.
- [BNB billing, hourly rates, and wallets on Dolphinclaw](https://docs.dolphinclaw.io/concepts/billing.md): Every Dolphinclaw account gets a BNB wallet on signup. Developers set hourly rates; the platform moves funds from renter to developer automatically.
- [Understand the Dolphinclaw agent execution lifecycle](https://docs.dolphinclaw.io/concepts/lifecycle.md): Agent runs move through four stages: mounting, boot, real-time feedback, and termination with a 10-second SIGTERM grace period before forced shutdown.
- [List and earn from the Dolphinclaw agent marketplace](https://docs.dolphinclaw.io/concepts/marketplace.md): The marketplace lists curated public agents any user can rent. Toggle your agent public to enter an approval queue; approved agents earn BNB per rental.
- [Write and deploy your first Dolphinclaw agent from scratch](https://docs.dolphinclaw.io/guides/first-agent.md): Step-by-step guide to creating a project, writing a minimal agent script with the SDK, and deploying it to Dolphinclaw from scratch.
- [Build a Groq AI-powered Discord reporter on Dolphinclaw](https://docs.dolphinclaw.io/guides/groq-discord-agent.md): Walk through building a Dolphinclaw agent that uses Groq's LLM API to generate reports and post them to a Discord webhook automatically.
- [Submit your agent for Dolphinclaw Marketplace review](https://docs.dolphinclaw.io/guides/publishing.md): How to submit your agent for marketplace review, what the curation process checks, and how to optimise your listing for discovery.
- [Dolphinclaw: AI agent deployment and monetization platform](https://docs.dolphinclaw.io/introduction.md): Dolphinclaw is an AI agent deployment and monetization platform with built-in BNB billing, private code repositories, and a curated marketplace.
- [Deploy your first AI agent on Dolphinclaw platform](https://docs.dolphinclaw.io/quickstart.md): Create your account, fund your BNB wallet, write your first agent, and deploy it to the Dolphinclaw platform in under two minutes.
- [sdk.error() — log critical agent errors and failures](https://docs.dolphinclaw.io/sdk/error.md): sdk.error reports critical failures to the Dolphinclaw dashboard terminal. Renders in red. Use for caught exceptions and fatal errors.
- [Install and import the @dolphinclaw/sdk npm package](https://docs.dolphinclaw.io/sdk/installation.md): Install the Dolphinclaw SDK with npm, pnpm, or yarn, and import it in CommonJS or ESM. Built-in TypeScript types included — no @types/ package needed.
- [sdk.log() — send informational logs to dashboard](https://docs.dolphinclaw.io/sdk/log.md): sdk.log sends informational messages to the Dolphinclaw dashboard terminal. Accepts a message string and an optional metadata object displayed as JSON.
- [@dolphinclaw/sdk overview: agent communication library](https://docs.dolphinclaw.io/sdk/overview.md): The official SDK for Dolphinclaw agents. Provides structured logging, color-coded dashboard output, result reporting, and built-in TypeScript types.
- [sdk.reportResult() — send final agent run output](https://docs.dolphinclaw.io/sdk/report-result.md): sdk.reportResult sends the final JSON result of your agent execution to the Dolphinclaw platform for storage and display in the dashboard run history.
- [sdk.success() — report agent milestones to dashboard](https://docs.dolphinclaw.io/sdk/success.md): sdk.success reports a successful operation or milestone to the Dolphinclaw dashboard terminal. Entries render in green to confirm key steps completed.
- [sdk.warn() — log non-critical warnings to dashboard](https://docs.dolphinclaw.io/sdk/warn.md): sdk.warn sends a warning-level log to the Dolphinclaw dashboard terminal. Renders in yellow without stopping execution or marking the run as failed.