> For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt.

# Getting Started with Lynxtron

Welcome to the Lynxtron documentation! We will create a Lynxtron project and start developing.

:::tip Explore first with Lynxtron Go

Want to try Lynxtron before creating a full project? [Download Lynxtron Go](/next/lynxtron/go.md) to edit and run templates and showcases immediately.

:::

## System Requirements

Before you begin, ensure your development environment meets the following requirements:

- [Node.js](https://nodejs.org/en): `^22.18.0 || ^24.0.0 || ^26.0.0`. You can check your version by running `node -v`.

### Optional Debugging Tools

- **AI and CLI debugging**: Use [`agent-lynx`](https://www.npmjs.com/package/agent-lynx) to inspect and debug Lynx UI from a coding agent or the command line.
- **Graphical debugging**: Use [Lynx DevTool](/next/guide/devtool.md) for Lynx UI, or Chrome DevTools for Node.js code running in Lynxtron.

## Installation


### Create a Project
It is recommended to quickly create a Lynxtron project by executing the following command:

```sh [npm]
npm create @lynx-js/lynxtron@latest
```

```sh [yarn]
yarn create @lynx-js/lynxtron
```

```sh [pnpm]
pnpm create @lynx-js/lynxtron@latest
```

```sh [bun]
bun create @lynx-js/lynxtron@latest
```

```sh [deno]
deno init --npm @lynx-js/lynxtron@latest
```
Follow the prompts to create a Lynxtron project.
The generated project includes an `AGENTS.md` with development and debugging instructions for coding agents. Open the project in your coding agent to get started, or follow the steps below to develop manually.
### Start Development
1. Navigate into your Lynxtron project:
```bash
cd <project-name>
```
2. Install dependencies:

   <PackageManagerTabs command="install" />

3. Start the application:
   <PackageManagerTabs command="run dev" />
After running, you will see the `Hello Lynxtron` application launch successfully, as shown below:

![](https://lf-lynx.tiktok-cdns.com/obj/lynx-artifacts-oss-sg/lynx-website/assets/lynxtron/Hello-Lynxtron.gif)

### Debug Your Application
The development command uses a DevTool-enabled Lynxtron runtime by default. Keep it running while you debug the main process or Lynx UI.
#### Debug with a Coding Agent or the CLI
The [`agent-lynx`](https://www.npmjs.com/package/agent-lynx) CLI exposes the same connection to scripts and coding agents. With the development command still running, you can discover the Lynxtron client, inspect its UI tree, read console output, or capture an annotated screenshot:
```bash
npx --yes agent-lynx list-clients
npx --yes agent-lynx snapshot
npx --yes agent-lynx get-console
npx --yes agent-lynx screenshot --annotate -o page.jpeg
```
`agent-lynx` includes the official [`lynx-devtool` skill](/next/ai/skills/lynx-devtool.md). A coding agent can discover and load its complete instructions directly from the CLI:
```bash
npx --yes agent-lynx skills list
npx --yes agent-lynx skills get lynx-devtool
```
The skill teaches the agent how to select clients and sessions and use DevTool commands for inspection, interaction, logs, sources, and screenshots.
#### Debug the Lynx UI with Lynx DevTool
Download and open [Lynx DevTool](/next/guide/devtool.md), select the running Lynxtron application, then inspect its elements, console output, and source code.
![Inspect a running Lynxtron application with Lynx DevTool](https://lf-lynx.tiktok-cdns.com/obj/lynx-artifacts-oss-sg/lynx-website/assets/lynxtron/debug/lynx-ui.png)
#### Debug Node.js Code with Chrome DevTools
The development command starts the Node.js inspector on `localhost:9222`.
1. Open `chrome://inspect` in Chrome.
2. Select **Configure...** and make sure `localhost:9222` is in the target discovery list.
3. Find the Lynxtron process under **Remote Target**, then select **inspect**.
![Inspect the Lynxtron main process from Chrome](https://lf-lynx.tiktok-cdns.com/obj/lynx-artifacts-oss-sg/lynx-website/assets/lynxtron/debug/main-process.png)
### Package Your Application
You can use the following command to package your application:

```sh [npm]
npm run pack
```

```sh [yarn]
yarn run pack
```

```sh [pnpm]
pnpm run pack
```

```sh [bun]
bun run pack
```

```sh [deno]
deno run npm:pack
```
`pack` uses the release runtime by default. To create a DevTool-enabled package for local debugging, add this top-level option:
```yaml title="electron-builder.yml"
lynxtron:
  runtimeVariant: devtool
```
Remove this option before distributing the application.
Open the packaged application and connect with [Lynx DevTool](/next/guide/devtool.md) in the same way as during development.
If the session list is empty on the first CLI connection, **quit and restart the app**. The CLI enables DevTool when it connects, but existing windows need to be recreated. Run `agent-lynx list-clients` again after restarting and select the current client address.
If you need to configure some custom parameters, you can modify the `electron-builder.yml` configuration file.
For detailed configuration parameters of `electron-builder.yml`, please refer to [electron-builder Configuration](https://www.electron.build/configuration).
