# AntelopeJS > AntelopeJS is an open-source TypeScript framework for modular business applications. It extends hexagonal architecture to the modules you install: modules consume versioned interfaces (contracts), provider modules implement them, and the application selects which implementation to load in `antelope.config.ts`. The `ajs` CLI creates, composes, runs, tests and builds projects and modules. ## Documentation Sets - [Full documentation](https://framework.antelopejs.com/llms-full.txt): Every page of the AntelopeJS framework documentation as one Markdown file. ## Get Started - [Get Started](https://framework.antelopejs.com/docs/get-started): Run your first module, understand its contract boundary, or embed AntelopeJS in an existing application. - [Introduction](https://framework.antelopejs.com/docs/get-started/introduction): AntelopeJS extends hexagonal architecture across application and ecosystem modules through explicit contracts and application-selected implementations. - [Installation](https://framework.antelopejs.com/docs/get-started/installation): Install the Antelopejs CLI and verify your development environment is ready. - [Quick Start](https://framework.antelopejs.com/docs/get-started/quick-start): Create a local module, observe its lifecycle, and verify development reloads before adding an HTTP server or database. - [Architecture](https://framework.antelopejs.com/docs/get-started/architecture): Map hexagonal architecture to AntelopeJS contracts, provider modules and application assembly, including the limits of implementation compatibility. ## Concepts - [Concepts](https://framework.antelopejs.com/docs/concepts): Choose the concept you need to design contracts, assemble providers, or operate modules safely. - [Interfaces](https://framework.antelopejs.com/docs/concepts/interfaces): Interfaces define the contracts that modules use to communicate — declaring functions, events, and registrations without tying them to any specific implementation. - [Modules](https://framework.antelopejs.com/docs/concepts/modules): Modules are the building blocks of an Antelopejs application — self-contained packages with a defined lifecycle, configuration, and interface bindings. - [Proxies](https://framework.antelopejs.com/docs/concepts/proxies): Proxies are the communication backbone of Antelopejs — AsyncProxy for function calls, EventProxy for broadcasting, and RegisteringProxy for registration systems. - [Configuration](https://framework.antelopejs.com/docs/concepts/configuration): Configure your Antelopejs project with antelope.config.ts — define modules, sources, environment overrides, logging, and per-environment settings. - [Logging](https://framework.antelopejs.com/docs/concepts/logging): The Antelopejs logging system provides severity levels, named channels, and configurable output formatting for structured application logs. - [Core Utilities](https://framework.antelopejs.com/docs/concepts/core-utilities): Core utility functions for interface declarations, implementations, module introspection, and decorator factories in Antelopejs. - [Runtime](https://framework.antelopejs.com/docs/concepts/runtime): Inspect the runtime environment of a running project and register development servers for discovery by external tooling. - [Glossary](https://framework.antelopejs.com/docs/concepts/glossary): Key terms and definitions used throughout the AntelopeJS documentation. - [Diagnostics](https://framework.antelopejs.com/docs/concepts/diagnostics): Module lifecycle operations published as node:diagnostics_channel tracing channels, for tracing, metrics, and profiling tools. - [Embedded Runtime](https://framework.antelopejs.com/docs/concepts/embedded-runtime): Run AntelopeJS modules inside an application that owns the process, and compare the embedded mode with the standalone mode driven by the ajs CLI. ## Module Development - [Module Development](https://framework.antelopejs.com/docs/module-development): Build a module, expose its contract, test its behavior, and make it discoverable. - [Creating a Module](https://framework.antelopejs.com/docs/module-development/creating-a-module): Create an Antelopejs module from scratch — initialize the project, configure the entry point, and register it in your application. - [Exporting Interfaces](https://framework.antelopejs.com/docs/module-development/exporting-interfaces): Create interface contracts with typed proxies, implement them with concrete logic, and extract standalone packages when multiple implementations appear. - [Testing](https://framework.antelopejs.com/docs/module-development/testing): Test Antelopejs modules with the built-in test runner — configure the test environment, write isolated tests, and validate interface implementations. - [Interface Registry](https://framework.antelopejs.com/docs/module-development/interface-registry): Register interfaces and implementations in the official registry to make them discoverable through the AntelopeJS CLI. ## Guides - [Guides](https://framework.antelopejs.com/docs/guides): Add an endpoint, persist data, authenticate requests, or integrate AntelopeJS with an existing application. - [API Routing](https://framework.antelopejs.com/docs/guides/api-routing): Build HTTP APIs with controllers, route decorators, parameter extraction, and structured responses in AntelopeJS. - [Database](https://framework.antelopejs.com/docs/guides/database): Define database tables, apply modifiers for hashing and encryption, and perform CRUD operations with data models in AntelopeJS. - [Authentication](https://framework.antelopejs.com/docs/guides/authentication): Sign and validate JWT tokens, protect routes with authentication decorators, and manage server-side cookie authentication in AntelopeJS. - [Data API](https://framework.antelopejs.com/docs/guides/data-api): Generate automatic CRUD endpoints from database tables with customizable routes, authentication, and middleware in AntelopeJS. - [Task API Tutorial](https://framework.antelopejs.com/docs/guides/full-stack-tutorial): Assemble a shared task API with database tables, login routes, explicit providers, and authenticated CRUD endpoints. - [Troubleshooting](https://framework.antelopejs.com/docs/guides/troubleshooting): Common errors and their solutions when working with AntelopeJS. - [Embed AntelopeJS in an Existing App](https://framework.antelopejs.com/docs/guides/embedded-runtime): Run AntelopeJS modules inside an application that owns the process, with AdonisJS 6 as a complete worked example. ## CLI Reference - [CLI Reference](https://framework.antelopejs.com/docs/cli): Find the command for creating, running, testing, and building an AntelopeJS project. - [Introduction](https://framework.antelopejs.com/docs/cli/introduction): Overview of the AntelopeJS CLI — installation, command structure, global options, and configuration storage. - [Project Commands](https://framework.antelopejs.com/docs/cli/project): Complete reference for AntelopeJS project commands — lifecycle management, module operations, and logging configuration. - [Module Commands](https://framework.antelopejs.com/docs/cli/module): Reference for AntelopeJS module commands — scaffold new modules and run test suites. - [Configuration](https://framework.antelopejs.com/docs/cli/config): Reference for AntelopeJS CLI configuration commands — view, set, and reset global settings. - [Cheat Sheet](https://framework.antelopejs.com/docs/cli/cheat-sheet): Quick reference for every AntelopeJS CLI command, option, and common workflow. - [Plugin API](https://framework.antelopejs.com/docs/cli/plugin-api): Build a CLI plugin whose output, errors and exit codes match ajs, with the @antelopejs/core/cli module. ## Community - [Community](https://framework.antelopejs.com/docs/community): Ask a focused question, report a reproducible bug, or contribute to the framework. - [Getting Help](https://framework.antelopejs.com/docs/community/getting-help): Need help with Antelopejs? Here's where to ask questions and how to get the best answers fast. - [How to Report Bugs](https://framework.antelopejs.com/docs/community/how-to-report-bugs): Found a bug? Here's how to report it so we can fix it quickly. - [Contributing to Antelopejs](https://framework.antelopejs.com/docs/community/contribution): Learn how to contribute to the Antelopejs ecosystem through code, documentation, and community participation. - [Framework Development](https://framework.antelopejs.com/docs/community/framework): Guidelines for contributing to the Antelopejs core framework. ## Optional - [AntelopeJS Interfaces](https://interfaces.antelopejs.com): the interfaces and the module catalogue - [Ecosystem hub](https://antelopejs.com): Framework, DMS and Cloud - [GitHub](https://github.com/antelopejs)