# Where to Find the Documentation for ego-lite: Complete Guide to Official Resources

> Find ego-lite documentation easily within the official GitHub repository. Access the README and specialized guides for quick setup and detailed information.

- Repository: [CitroLabs/ego-lite](https://github.com/citrolabs/ego-lite)
- Tags: getting-started
- Published: 2026-08-03

---

**The documentation for ego-lite is located directly in the GitHub repository at `citrolabs/ego-lite`, with the primary entry point being [`README.md`](https://github.com/citrolabs/ego-lite/blob/main/README.md) and specialized guides distributed across [`package/ego-browser/README.md`](https://github.com/citrolabs/ego-lite/blob/main/package/ego-browser/README.md), [`skills/ego-browser/SKILL.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/SKILL.md), and the `spec/` directory.**

The `ego-lite` project ships its entire documentation as plain-text Markdown and JSON files within the source tree. This approach ensures version-controlled, always-current reference material that developers and AI agents can access without external dependencies. According to the `citrolabs/ego-lite` source code, documentation spans seven key files covering installation, API usage, skill development, and formal specifications.

## Primary Documentation Files

### Project Overview (README.md)

The root [`README.md`](https://github.com/citrolabs/ego-lite/blob/main/README.md) serves as the main entry point for the project. It contains high-level descriptions, installation steps, and usage examples for getting started with `ego-lite`. New users should start here before diving into component-specific guides.

### ego-browser Package Documentation (package/ego-browser/README.md)

Located at [`package/ego-browser/README.md`](https://github.com/citrolabs/ego-lite/blob/main/package/ego-browser/README.md), this file details the Node.js harness (`ego-browser`), its public helpers, the full API surface, and development commands. This is the canonical reference for developers building scripts and tools on top of the browser automation layer.

Key helpers documented include:

- `go(url)` — Navigate to a URL
- `click(selector)` — Click an element
- `type(selector, value)` — Input text
- `screenshot()` — Capture page state
- `newTaskSpace(name)` — Create isolated browsing sessions
- `runSiteTool(site, tool, params)` — Execute site-specific learned behaviors

### Agent-Facing Skill Guide (skills/ego-browser/SKILL.md)

The [`skills/ego-browser/SKILL.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/SKILL.md) file provides the canonical guide for AI agents using the `ego-browser` binary. It documents the `ego-browser nodejs <<'EOF' … EOF` pattern for executing automation scripts. AI systems and agent frameworks should reference this file as the "official" usage specification.

### Installation Reference (skills/ego-browser/references/install.md)

Step-by-step installation instructions for the skill package reside at [`skills/ego-browser/references/install.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/references/install.md). This covers prerequisite setup, dependency installation, and verification steps.

### Agent-Skills Specification (spec/agent-skills-spec.md)

The formal specification at [`spec/agent-skills-spec.md`](https://github.com/citrolabs/ego-lite/blob/main/spec/agent-skills-spec.md) defines the JSON/YAML schema for skill definitions used by agents. Developers extending `ego-lite` with custom capabilities must consult this document to ensure compatibility with the agent runtime.

### Learning Manifests (skills/ego-browser/learnings/)

Per-site "learning" definitions illustrate how to build site-specific tools. The [`skills/ego-browser/learnings/google/manifest.json`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/learnings/google/manifest.json) serves as a reference implementation, demonstrating how structured site behaviors are defined and loaded.

### Contribution Guidelines (CONTRIBUTING.md)

[`CONTRIBUTING.md`](https://github.com/citrolabs/ego-lite/blob/main/CONTRIBUTING.md) covers code contributions, documentation standards, and release processes for those participating in project development.

## Practical Usage Examples from the Documentation

The following patterns demonstrate typical usage as documented across these files.

### Running a Script with the ego-browser CLI

```javascript
// Save as script.js
await go('https://example.com');
await click('loc=css:#login');
await type('loc=css:#username', 'alice');
await type('loc=css:#password', 'secret');
await click('loc=css:#submit');

```

Execute via the built CLI:

```bash
node dist/out/index.js <<'JS'
$(cat script.js)
JS

```

### Using Site-Specific Learnings (Google Search)

```js
// Load the Google learning manifest (automatically available after install)
await runSiteTool('google', 'search', { query: 'ego-lite' });

```

### Creating Task Spaces and Navigating

```js
const space = await newTaskSpace('my-session');
await switchTaskSpace(space.id);
await nav('https://github.com/citrolabs/ego-lite');

```

### Capturing Screenshots

```js
const png = await screenshot();
await writeFile('screenshot.png', png);

```

## How to Access the Documentation

All documentation files are accessible through standard GitHub URLs:

- Browse directly: `https://github.com/citrolabs/ego-lite/blob/main/[path]`
- Clone locally: `git clone https://github.com/citrolabs/ego-lite.git`

Since files are plain Markdown and JSON, they render natively on GitHub and in any Markdown viewer.

## Summary

- **Where to find the documentation for ego-lite**: All documentation lives in the `citrolabs/ego-lite` repository as version-controlled Markdown and JSON files.
- **Start with [`README.md`](https://github.com/citrolabs/ego-lite/blob/main/README.md)** for project overview and quick-start guidance.
- **Developers**: Reference [`package/ego-browser/README.md`](https://github.com/citrolabs/ego-lite/blob/main/package/ego-browser/README.md) for API details and [`spec/agent-skills-spec.md`](https://github.com/citrolabs/ego-lite/blob/main/spec/agent-skills-spec.md) for extension standards.
- **AI agents and automation systems**: Use [`skills/ego-browser/SKILL.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/SKILL.md) as the canonical usage reference.
- **Installation steps**: See [`skills/ego-browser/references/install.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/references/install.md) for setup instructions.

## Frequently Asked Questions

### Is there external documentation or a website for ego-lite?

No. As implemented in `citrolabs/ego-lite`, all documentation is maintained within the repository itself. This ensures documentation stays synchronized with code changes and remains accessible offline. The GitHub-rendered Markdown files serve as the complete reference.

### Which documentation file should I read first as a new user?

Start with the root [`README.md`](https://github.com/citrolabs/ego-lite/blob/main/README.md) for project context and installation. Then proceed to [`package/ego-browser/README.md`](https://github.com/citrolabs/ego-lite/blob/main/package/ego-browser/README.md) if you are building automation scripts, or [`skills/ego-browser/SKILL.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/SKILL.md) if you are configuring an AI agent to use `ego-browser`.

### How do I find documentation for specific helper functions like `runSiteTool`?

The [`package/ego-browser/README.md`](https://github.com/citrolabs/ego-lite/blob/main/package/ego-browser/README.md) file contains the complete API reference for all helper functions including `go`, `click`, `type`, `screenshot`, `newTaskSpace`, `nav`, and `runSiteTool`. Each helper's parameters, return values, and behavior notes are documented there.

### What is the difference between SKILL.md and the package README?

[`skills/ego-browser/SKILL.md`](https://github.com/citrolabs/ego-lite/blob/main/skills/ego-browser/SKILL.md) is optimized for AI agent consumption, focusing on the `ego-browser nodejs <<'EOF'` execution pattern. [`package/ego-browser/README.md`](https://github.com/citrolabs/ego-lite/blob/main/package/ego-browser/README.md) is developer-oriented, covering the full API surface, development workflow, and testing procedures.