A declarative and extensible framework for building Elixir applications.
Go to file
2024-07-19 12:40:09 -04:00
.github chore: remove unnecessary quotes from dependabot.yml 2024-06-18 10:15:10 -04:00
benchmarks improvement: bring uuid version 7 into the core (#1253) 2024-06-23 18:16:20 -04:00
config fix: pass entire private context to related query in lazy?: true 2024-07-02 10:24:49 -04:00
documentation chore: get build passing 2024-07-19 12:40:09 -04:00
lib chore: get build passing 2024-07-19 12:40:09 -04:00
logos improvement!: 3.0 (#955) 2024-03-27 16:31:59 -04:00
scripts chore: add gource script 2023-12-27 16:37:24 -05:00
test chore: get build passing 2024-07-19 12:40:09 -04:00
.check.exs improvement!: 3.0 (#955) 2024-03-27 16:31:59 -04:00
.credo.exs improvement: handle pkey-less resources when attaching fields 2024-01-21 00:45:35 -05:00
.doctor.exs ci: remove tweets/switch to standardized CI pipeline 2023-01-31 11:15:09 -05:00
.formatter.exs feat: Allow field policies to hide private fields (#1289) 2024-07-15 08:16:52 -04:00
.gitignore * improvement: add data layer introspection to Ash.Resource.Info (#610) 2023-06-10 13:17:17 -04:00
.gitpod.yml fix: handle builtin types in unions (#752) 2023-10-25 08:31:25 -04:00
.tool-versions improvement: Add Ash.Resource.Igniter.domain to get the domain of a resource 2024-07-18 13:00:56 -04:00
backers.md chore: update backers.md 2022-11-25 14:45:35 -05:00
CHANGELOG.md chore: release version v3.2.4 2024-07-18 18:18:55 -04:00
coveralls.json improvement!: 3.0 (#955) 2024-03-27 16:31:59 -04:00
mix.exs fix: warnings emitted by removed reactor behaviour function. (#1325) 2024-07-18 23:06:34 -04:00
mix.lock chore: get build passing 2024-07-19 12:40:09 -04:00
README.md improvement: update getting started guide and document generators 2024-07-08 17:15:52 -04:00

Logo Logo

Elixir CI License: MIT Hex version badge Hexdocs badge

Ash Framework

Welcome! Here you will find everything you need to know to get started with and use Ash. This documentation is best viewed on hexdocs.

Dive In

About the Documentation

Tutorials walk you through a series of steps to accomplish a goal. These are learning-oriented, and are a great place for beginners to start.

Topics provide a high level overview of a specific concept or feature. These are understanding-oriented, and are perfect for discovering design patterns, features, and tools related to a given topic.

How-to guides are goal-oriented recipes for accomplishing specific tasks. These are also good to browse to get an idea of how Ash works and what is possible with it.

Reference documentation is produced automatically from our source code. It comes in the form of module documentation and DSL documentation. This documentation is information-oriented. Use the sidebar and the search bar to find relevant reference information.



About Ash









The Ash ecosystem consists of numerous packages, all of which have their own documentation. If you can't find something in this documentation, don't forget to search in any potentially relevant package.

Data Layers

API Extensions



Resource Utilities

  • AshOban | Background jobs and scheduled jobs for Ash, backed by Oban
  • AshArchival | Archive resources instead of deleting them
  • AshStateMachine | Create state machines for resources
  • AshPaperTrail | Keep a history of changes to resources
  • AshCloak | Encrypt attributes of a resource

Admin & Monitoring


  • Smokestack | Declarative test factories for Ash resources