# Magma v0.3.2 - Table of Contents

An IDE for prompts.

## GUIDES

- [Changelog](changelog.md)

- User Guide
  - [Introduction](01-introduction.md)
  - [Installation](02-installation.md)
  - [Transclusion Resolution](03-transclusion.md)
  - [Vault Structure & Configuration](04-vault-structure.md)
  - [Working with Prompts](05-prompts.md)
  - [Sessions: Multi-turn Workflows](06-sessions.md)
  - [Roadmap & Contributions](07-limitations.md)

## Modules

- [Magma](Magma.md): Magma is a prompt development environment for working with coding agents.

- Vault
  - [Magma.Vault](Magma.Vault.md): A specialized Obsidian vault with directories for the Magma-specific documents.
  - [Magma.Vault.BaseVault](Magma.Vault.BaseVault.md): Utilities for interacting with predefined and custom base vaults.
  - [Magma.Vault.Discovery](Magma.Vault.Discovery.md): Discovers the Magma vault path.
  - [Magma.Vault.Migration](Magma.Vault.Migration.md): Migration of Magma vaults to be compatible with newer versions.
  - [Magma.Vault.Version](Magma.Vault.Version.md): Manages the versioning of the Magma vault.

- Documents
  - [Magma.Document](Magma.Document.md): A behavior for the different kinds of document types in Magma.
  - [Magma.Prompt](Magma.Prompt.md): A standalone prompt document for LLM execution.
  - [Magma.PromptResult](Magma.PromptResult.md): Stores the result of an LLM prompt execution.
  - [Magma.Session](Magma.Session.md): An interactive prompt document supporting multi-turn conversations with coding agents.
  - [Magma.View](Magma.View.md): Utility module with helper functions for creating the content of Magma documents.

- DocumentStruct
  - [Magma.DocumentStruct](Magma.DocumentStruct.md): Recursive section-based representation of a Markdown document for transclusion resolution.
  - [Magma.DocumentStruct.Section](Magma.DocumentStruct.Section.md): Recursive structure for the nested sections of a `Magma.DocumentStruct`.

- Generation
  - [Magma.Generation](Magma.Generation.md): Generic adapter-based `Magma.Prompt` execution.
  - [Magma.Generation.Manual](Magma.Generation.Manual.md): `Magma.Generation` adapter for manual prompt execution.
  - [Magma.Generation.OpenAI](Magma.Generation.OpenAI.md): `Magma.Generation` adapter for the OpenAI API.

- Config
  - [Magma.Config](Magma.Config.md): Cache for the vault-based configuration.
  - [Magma.Config.Document](Magma.Config.Document.md): Foundational behaviors for Magma configuration documents.
  - [Magma.Config.System](Magma.Config.System.md): `Magma.Config.Document` for the general Magma system configuration.

- CLI
  - [Magma.CLI](Magma.CLI.md): Main entry point for the Magma CLI.
  - [Magma.CLI.Command](Magma.CLI.Command.md): Behaviour for CLI commands
  - [Magma.CLI.Command.CopyPrompt](Magma.CLI.Command.CopyPrompt.md): CLI command to copy a compiled prompt to the clipboard.
  - [Magma.CLI.Command.ExecPrompt](Magma.CLI.Command.ExecPrompt.md): CLI command to execute a prompt or session via LLM.
  - [Magma.CLI.Command.Help](Magma.CLI.Command.Help.md): CLI command to show available commands.
  - [Magma.CLI.Command.ImportSession](Magma.CLI.Command.ImportSession.md): CLI command to import a response file into a session document.
  - [Magma.CLI.Command.Init](Magma.CLI.Command.Init.md): CLI command to initialize a new Magma vault.
  - [Magma.CLI.Command.Version](Magma.CLI.Command.Version.md): CLI command to show the Magma version.
  - [Magma.CLI.FileOps](Magma.CLI.FileOps.md): File operations abstraction replacing Mix.Generator functions.
  - [Magma.CLI.Helper](Magma.CLI.Helper.md): Helper functions for CLI commands.

  - [Magma.CLI.IO](Magma.CLI.IO.md): CLI I/O abstraction replacing Mix.shell() functions.

- Exceptions
  - [Magma.DocumentNotFound](Magma.DocumentNotFound.md): Represents a missing document that is referenced somewhere.

  - [Magma.InvalidDocumentType](Magma.InvalidDocumentType.md): Raised when a document type does not match the expected one.

## Mix Tasks

- [mix magma.prompt.copy](Mix.Tasks.Magma.Prompt.Copy.md)
- [mix magma.prompt.exec](Mix.Tasks.Magma.Prompt.Exec.md): Executes a prompt.
- [mix magma.prompt.gen](Mix.Tasks.Magma.Prompt.Gen.md): Generates a custom prompt document.
- [mix magma.session.import_response](Mix.Tasks.Magma.Session.ImportResponse.md)
- [mix magma.vault.init](Mix.Tasks.Magma.Vault.Init.md)
- [mix magma.vault.migrate](Mix.Tasks.Magma.Vault.Migrate.md): Migrates the Magma vault to a newer Magma version