# NebulaAPI v0.7.1 - Table of Contents

> Compile-time selective compilation and transparent distributed execution for Erlang/Elixir clusters

## Pages

- [NebulaAPI](readme.md)
- [Documentation](documentation.md)

- Guides
  - [1. Configuration](configuration.md)
  - [2. Defining APIs](defining.md)
  - [3. Calling across nodes](calling.md)
  - [4. Gotchas and troubleshooting](gotchas.md)

- Deep dive
  - [NebulaAPI AST Deep-Dive](ast-deep-dive.md)

- Project
  - [About LLMs](about-llms.md)

## Modules

- Public API
  - [NebulaAPI](NebulaAPI.md):  Documentation for `NebulaAPI`.

  - [NebulaAPI.APIServer](NebulaAPI.APIServer.md): Cluster-wide core: owns the `:pg` routing scope and the node-info ETS cache, and
implements remote method calls. (Per-module workers are not managed here — each
consumer app supervises its own through `NebulaAPI.Server`.)
  - [NebulaAPI.Config](NebulaAPI.Config.md)
  - [NebulaAPI.Routes](NebulaAPI.Routes.md): The per-node routing map — where each `defapi` is served locally vs reached over RPC.
  - [NebulaAPI.Server](NebulaAPI.Server.md): Per-application supervisor for NebulaAPI workers.

- Internals
  - [NebulaAPI.APIServer.NodesInfoCache](NebulaAPI.APIServer.NodesInfoCache.md): Per-node background refresher for the cluster node-info snapshot.
  - [NebulaAPI.APIServer.Worker](NebulaAPI.APIServer.Worker.md)
  - [NebulaAPI.AST](NebulaAPI.AST.md): AST macros for NebulaAPI.
  - [NebulaAPI.AST.Builder](NebulaAPI.AST.Builder.md): AST builder for NebulaAPI functions.
  - [NebulaAPI.AST.Parser](NebulaAPI.AST.Parser.md)
  - [NebulaAPI.CompilerCheck](NebulaAPI.CompilerCheck.md): Pure decision logic for the `:nebula` Mix compiler (`Mix.Tasks.Compile.Nebula`).

## Mix Tasks

- Public API
  - [mix nebula.routes](Mix.Tasks.Nebula.Routes.md): Prints where each `defapi` is served, "git lola"-style: one continuous vertical rail per node
(name + `@short`/`&tag` selectors), with a `●` marking each node that serves a method and the
rail (`|`) continuing where it isn't local; current node in bold, serves-nothing nodes greyed.

- Internals
  - [mix compile.nebula](Mix.Tasks.Compile.Nebula.md): Mix compiler that guards against forgetting `nebula_api_server/0`.