# Clayzo

- [Overview](https://docs.clayzo.com/index.md): Author animations with your coding agent, check them, and ship them as video or as a player on your site.
- [Quickstart](https://docs.clayzo.com/quickstart.md): From an empty project to an exported animation.
- [Installation](https://docs.clayzo.com/installation.md): Requirements, what the initializer installs, and how to install by hand.
- [Authentication](https://docs.clayzo.com/authentication.md): Which commands need a sign in, how to sign in, and how to run in CI.
- [Working with agents](https://docs.clayzo.com/authoring/agents.md): Install the Clayzo skills and brief your agent so it produces motion you'd ship.
- [Writing documents](https://docs.clayzo.com/authoring/documents.md): The animation document format, and how to author one in TypeScript.
- [Interactivity](https://docs.clayzo.com/authoring/interactivity.md): Pointer behaviour, host inputs and triggers, and what happens to them on export.
- [Fonts and assets](https://docs.clayzo.com/authoring/fonts-and-assets.md): How text finds its font, how images are referenced, and how to make a document portable.
- [Audio](https://docs.clayzo.com/authoring/audio.md): Add a soundtrack or sound effects to a document.
- [Previewing and review](https://docs.clayzo.com/authoring/previewing.md): Frame sheets, the preview server, loop seams and the review packet.
- [Exporting media](https://docs.clayzo.com/exporting/media.md): Render a document to MP4, MOV, WebM, animated WebP, GIF, SVG or a PNG sequence.
- [Bundles (.clayzo)](https://docs.clayzo.com/exporting/bundles.md): Package a document with its fonts, images and audio so it plays anywhere.
- [Choosing a renderer](https://docs.clayzo.com/playback/choosing-a-renderer.md): Two players, same call. Pick one at integration time and ship only that one.
- [WebGL player](https://docs.clayzo.com/playback/webgl-player.md): The lightweight player. No setup, nothing to serve, about 250 KB compressed.
- [CanvasKit player](https://docs.clayzo.com/playback/canvaskit-player.md): The full-fidelity player. The same renderer the export uses, so playback can't drift from the video.
- [React and Next.js](https://docs.clayzo.com/playback/react.md): The ClayzoPlayer component and the useClayzoPlayer hook, from either player package.
- [iOS and macOS](https://docs.clayzo.com/playback/ios.md): Play documents natively in Swift apps. One Swift package, about 1.4 MB, no web view.
- [Troubleshooting](https://docs.clayzo.com/troubleshooting.md): The problems people hit, and what they mean.
- [CLI overview](https://docs.clayzo.com/cli/overview.md): Every clayzo command, and the conventions they share.
- [init](https://docs.clayzo.com/cli/init.md): Install the Clayzo packages and agent skills in the current project.
- [preview](https://docs.clayzo.com/cli/preview.md): Serve a page that plays the document and can export it on this machine's GPU.
- [render-frame](https://docs.clayzo.com/cli/render-frame.md): Render one frame, a labelled sheet of frames, or the loop seam.
- [review](https://docs.clayzo.com/cli/review.md): Write a revision-bound review packet: review.json, contact-sheet.png and frames/.
- [package](https://docs.clayzo.com/cli/package.md): Build a portable .clayzo bundle with the document's images, fonts and audio embedded.
- [export](https://docs.clayzo.com/cli/export.md): Export mp4, mov, gif, webm, animated webp, a PNG sequence or an animated SVG.
- [doctor and update](https://docs.clayzo.com/cli/doctor.md): See what's installed, and bring it all up to date.
- [login, logout and token](https://docs.clayzo.com/cli/auth.md): Authorize a device, sign out, and manage CI tokens.

## Optional

- [App](https://app.clayzo.com)
- [npm](https://www.npmjs.com/package/clayzo)
- [Agent skills](https://github.com/Clayzo/agent-skills)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.