# paxos_kv v0.6.0 - API Reference

## Modules

- [PaxosKV](PaxosKV.md): `PaxosKV` is the main API module. Most of the time you should interact with
the application via functions in this module.
- [PaxosKV.Acceptor](PaxosKV.Acceptor.md): Implements the Acceptor role in the Paxos consensus algorithm.
- [PaxosKV.Application](PaxosKV.Application.md): OTP application module for PaxosKV.
- [PaxosKV.Bucket](PaxosKV.Bucket.md): Supervisor for a bucket's Paxos processes.
- [PaxosKV.Cluster](PaxosKV.Cluster.md): Manages the cluster state and node membership.
- [PaxosKV.Helpers](PaxosKV.Helpers.md): Internal utility functions for PaxosKV.
- [PaxosKV.Helpers.Msg](PaxosKV.Helpers.Msg.md): Macros for pattern matching common Erlang messages.
- [PaxosKV.Learner](PaxosKV.Learner.md): Implements the Learner role in the Paxos consensus algorithm.
- [PaxosKV.Learner.State](PaxosKV.Learner.State.md): State struct for the Paxos Learner process.
- [PaxosKV.PauseUntil](PaxosKV.PauseUntil.md): A special GenServer that executes a function during initialization.
- [PaxosKV.Proposer](PaxosKV.Proposer.md): Implements the Proposer role in the Paxos consensus algorithm.
- [PaxosKV.Proposer.State](PaxosKV.Proposer.State.md): State module for the Paxos Proposer process.
- [paxos_kv](paxos_kv.md): Erlang interface for the PaxosKV distributed key-value store.

## Mix Tasks

- [mix node](Mix.Tasks.Node.md): Starts the node in distributed mode with a numbered node name schema.