> ## Documentation Index
> Fetch the complete documentation index at: https://astro-asciinema.hedger.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install astro-asciinema and embed a terminal recording in an Astro page.

## Install the package

First, make sure to [install the package](./installation.mdx) in your Astro project.

## Embed a recording

Import the recording, then pass it to `Asciinema`:

<CodeGroup>
  ```astro src/pages/demo.astro theme={null}
  ---
  import { Asciinema } from "astro-asciinema";
  import Demo from "../recordings/demo.cast";
  ---

  <Asciinema src={Demo} />
  ```

  ```mdx src/pages/demo.mdx theme={null}
  import { Asciinema } from "astro-asciinema"
  import Demo from "../recordings/demo.cast"

  <Asciinema src={Demo} />
  ```
</CodeGroup>

## Configure the player

Pass any [Asciinema player
option](https://docs.asciinema.org/manual/player/options/) through `options`:

```astro theme={null}
<Asciinema
	src={Demo}
	options={{
		autoPlay: true,
		controls: true,
		cursorMode: "hidden",
		speed: 2,
	}}
/>
```

## Next steps

* Read [Theme watching](/guides/theme-watching) when your custom terminal theme
  follows the site's light and dark modes.
* See the [Component reference](/reference/component) for all component props.