# Athas

> Athas is an open-source code editor for macOS, Windows and Linux, built with Tauri, React, TypeScript and Rust.

These guides describe the current documented product. Features vary by release, platform, provider and plan. Use the linked guide for requirements and limits; do not infer undocumented APIs.

- [Documentation](https://athas.dev/docs)
- [Complete documentation as Markdown](https://athas.dev/llms-full.txt)
- [Download](https://athas.dev/download)
- [Source code](https://github.com/athasdev/athas)
- [License](https://github.com/athasdev/athas/blob/main/LICENSE): AGPL-3.0

## Start here

- [Getting started](https://athas.dev/docs/llms): Install Athas, open a project, and choose the guides for your development workflow.
- [Installation](https://athas.dev/docs/llms/installation): Install Athas on macOS, Windows or Linux, choose a package, and safely uninstall it.
- [Updates](https://athas.dev/docs/llms/updates): Update Athas with the built-in updater or your package manager, and recover from installation problems.
- [Troubleshooting](https://athas.dev/docs/llms/troubleshooting): Resolve startup, language tooling, terminal, AI, and connection problems with actionable checks.

## Editing

- [Quick Open](https://athas.dev/docs/llms/quick-open): Open files by name with fuzzy search, recent files, previews, and keyboard navigation.
- [Editing code](https://athas.dev/docs/llms/editing): Save files, use multiple cursors, fold code, and preview Markdown in Athas.
- [Search and replace](https://athas.dev/docs/llms/search): Find text in a file or across your project, filter results, and review replacements.
- [Command Palette](https://athas.dev/docs/llms/command-palette): Find available Athas commands, run actions from the keyboard, and discover your current shortcuts.
- [Language servers](https://athas.dev/docs/llms/language-servers): Set up completions, diagnostics, symbols, and navigation with language integrations.
- [Outline](https://athas.dev/docs/llms/outline): Navigate symbols in the active file from the sidebar or Command Palette.
- [Diagnostics](https://athas.dev/docs/llms/diagnostics): Inspect problems, jump to source, apply quick fixes, and filter diagnostics in the bottom pane.
- [Formatting and linting](https://athas.dev/docs/llms/formatting): Format a file or selection, enable format on save, and diagnose missing formatters.
- [Syntax Highlighting](https://athas.dev/docs/llms/syntax-highlighting): Understand built-in Tree-sitter syntax highlighting, language integrations, and language intelligence.

## Workspaces and tools

- [Workspaces](https://athas.dev/docs/llms/workspaces): Open project folders, switch between projects, and keep worktrees or remote workspaces separate.
- [Terminal](https://athas.dev/docs/llms/terminal): Integrated terminal with shell integration, split panes, and multiple shells
- [Browser](https://athas.dev/docs/llms/browser): Open web pages and local development servers in editor tabs
- [CLI](https://athas.dev/docs/llms/cli): Open files, viewers, terminals, and remote workspaces from the command line
- [Remote connections](https://athas.dev/docs/llms/remote): Connect to SSH or SFTP hosts, verify host identity, and reopen saved connections.
- [WSL](https://athas.dev/docs/llms/wsl): Open and edit Windows Subsystem for Linux projects

## Git and GitHub

- [Git Integration](https://athas.dev/docs/llms/git-integration): Review file changes, stage and commit work, and navigate Git branches, history, and worktrees.
- [GitHub Integration](https://athas.dev/docs/llms/github-integration): Connect GitHub for dashboard inbox sync and desktop repository views.
- [Branches](https://athas.dev/docs/llms/git-branches): Create, switch, merge, and delete Git branches while protecting local changes.
- [Worktrees](https://athas.dev/docs/llms/git-worktrees): Open and manage Git worktrees as Athas workspaces
- [Diff Viewer](https://athas.dev/docs/llms/git-diff): Compare working-tree, staged, and historical changes with inline or side-by-side diffs.

## Data

- [Database Viewer](https://athas.dev/docs/llms/database-viewer): Open SQLite and DuckDB files or connect to PostgreSQL, MySQL, MongoDB, and Redis from Athas.
- [SQLite](https://athas.dev/docs/llms/sqlite): Open and inspect SQLite database files directly in Athas.
- [DuckDB](https://athas.dev/docs/llms/duckdb): Open DuckDB files through the Athas database provider system.
- [PostgreSQL](https://athas.dev/docs/llms/postgresql): Connect to PostgreSQL databases, inspect schemas, and run queries from Athas.
- [MySQL](https://athas.dev/docs/llms/mysql): Connect to MySQL databases, browse tables, and run SQL queries from Athas.
- [MongoDB](https://athas.dev/docs/llms/mongodb): Connect to MongoDB, browse collections, and inspect documents from Athas.
- [Redis](https://athas.dev/docs/llms/redis): Connect to Redis, scan keys, inspect values, and edit key data from Athas.

## AI and agents

- [AI](https://athas.dev/docs/llms/ai): Understand the AI features in Athas and choose the right workflow.
- [Athas Agent](https://athas.dev/docs/llms/athas-agent): Use the built-in coding agent with project context, tools, permissions, and reviewable edits.
- [Inline AI](https://athas.dev/docs/llms/inline-ai): Choose Tab completion separately from inline edits and review generated changes in the editor.
- [Providers and Models](https://athas.dev/docs/llms/ai-providers): Choose default and feature models, configure provider keys or local endpoints, and diagnose connection failures.
- [External Agents](https://athas.dev/docs/llms/external-agents): Run installed CLI coding agents from the Athas AI panel.
- [Agent context](https://athas.dev/docs/llms/agent-context): Give agents useful project context, set repository rules, and understand ignore-file boundaries.
- [MCP servers](https://athas.dev/docs/llms/mcp): Connect agent tools through MCP and understand transport, credentials, and permissions.
- [MCP Servers](https://athas.dev/docs/llms/mcp-servers): Give agents in Athas extra tools with Model Context Protocol servers.

## Sharing and teams

- [Share to Web](https://athas.dev/docs/llms/sharing): Share read-only snapshots of editor buffers, code selections, and agent conversations.
- [Collaboration](https://athas.dev/docs/llms/collaboration): Use Teams workspace invites, roles, channels, presence, and metadata updates.
- [Dashboard integrations](https://athas.dev/docs/llms/dashboard-integrations): Connect GitHub, Linear, Vercel, and Sentry to your Athas inbox.
- [Enterprise controls](https://athas.dev/docs/llms/enterprise): Understand managed workspaces, integration allowlists, and organization AI policies.

## Customize

- [Settings](https://athas.dev/docs/llms/settings): Customize Athas across appearance, editor, Git, terminal, AI, account, and advanced controls.
- [Themes](https://athas.dev/docs/llms/themes): Create, import, and manage custom Athas color themes
- [Keymaps](https://athas.dev/docs/llms/keymaps): Inspect default shortcuts, select a preset, and customize bindings for your focused pane.
- [Vim mode](https://athas.dev/docs/llms/vim): Enable modal editing, use supported Vim commands, and resolve shortcut conflicts.
- [Integrations](https://athas.dev/docs/llms/integrations): Athas-maintained integrations for languages, tools, agents, and your workspace.

## Project and reference

- [What's new](https://athas.dev/docs/llms/changelog): Read Athas release notes, improvements and fixes, then find update and regression guidance.
- [Telemetry](https://athas.dev/docs/llms/telemetry): What Athas sends, what it does not send, and how local telemetry delivery works.
- [Contributing](https://athas.dev/docs/llms/contributing): Set up Athas from source, run the required checks, and submit a focused contribution.
- [Documentation for LLMs](https://athas.dev/docs/llms/for-llms): Read complete Athas documentation as Markdown, cite source pages, and choose focused context.