Skip to the page
aukdocs
/
Start Library Packages Errors Glossary
0 of 12 steps done

Start here

  • 1Getting started
  • 2A tour of Auk

The language

  • 3Basics
  • 4Functions, clauses and patterns
  • 5Structs, enums and shapes
  • 6Errors and optionals
  • 7Effects
  • 8Tests, contracts and holes
  • 9Modules and packages
  • 10Units of measure
  • 11Concurrency
  • 12Calling C

Tools

  • The auk command
  • raft, the package manager
  • Testing and debugging
  • Live reload
  • Editors
  • Auk with AI agents

Reference

  • Core library
  • Package catalog
  • Package docs
  • Error codes
  • Cheat sheet
  • Glossary

Working on Auk

  • Compiler architecture
  • Low-level Auk (raw)
  • raft design notes

Search the docs

Type in the box at the top. Results appear as you type.

What you can search for

  • A word you don't know: effect, clause, shape.
  • A function or a piece of syntax: fs.read, sort_by, match.
  • An error code from the compiler: E0200.
  • A question: how do I read a file.

Or start from one of these

  • Install Auk
  • Run my first program
  • Understand a compiler error
  • Handle something that can fail
  • Read or write a file
  • Work with lists and maps
  • Write a test
  • Add a package
  • Parse JSON
  • Make an HTTP request
  • Look up a word

Auk docs · written in Auk, served live by splash.

auk-lang.org · Package registry · Glossary · Search