# hyperlocalise

## Docs

- [check](https://hyperlocalise.dev/commands/check.md): Check localized files for not-localized content, orphaned keys, missing target files, and translation hygiene issues.
- [crowdin](https://hyperlocalise.dev/commands/crowdin.md): Crowdin-compatible file workflow commands powered by crowdin.yml.
- [eval](https://hyperlocalise.dev/commands/eval.md): Experimental: Run translation quality experiments and compare candidate reports against a baseline.
- [init](https://hyperlocalise.dev/commands/init.md): Create or overwrite the i18n.yml template in your project.
- [Commands overview](https://hyperlocalise.dev/commands/overview.md): Top-level command map with links to task-focused command docs.
- [run](https://hyperlocalise.dev/commands/run.md): Plan and execute local translation generation from configured source files.
- [status](https://hyperlocalise.dev/commands/status.md): Report translation status per key/namespace/locale in CSV, with optional interactive TTY dashboard.
- [sync pull](https://hyperlocalise.dev/commands/sync-pull.md): Pull completed Hyperlocalise job outputs into local files.
- [sync push](https://hyperlocalise.dev/commands/sync-push.md): Submit source files to Hyperlocalise translation jobs.
- [version, update, and completion](https://hyperlocalise.dev/commands/version-and-completion.md): Check installed version, self-update the CLI, and generate shell completion scripts.
- [i18n config](https://hyperlocalise.dev/configuration/i18n-config.md): Field-by-field guide for the i18n config file used by run, status, and sync commands.
- [Path templates](https://hyperlocalise.dev/configuration/path-templates.md): Use source and target placeholders safely in bucket file mappings.
- [Provider credentials](https://hyperlocalise.dev/configuration/provider-credentials.md): Set credentials for OpenAI, Azure OpenAI, Anthropic, Gemini, Bedrock, LM Studio, Ollama, Groq, and remote TMS adapters.
- [Development](https://hyperlocalise.dev/contributing/development.md): Develop and validate the hyperlocalise CLI in Go.
- [Docs contributions](https://hyperlocalise.dev/contributing/docs-contributions.md): How to contribute improvements to this documentation site.
- [Release maintenance](https://hyperlocalise.dev/contributing/release-maintenance.md): Maintainer workflow for quality gates and CLI release publishing.
- [First project](https://hyperlocalise.dev/getting-started/first-project.md): Set up a minimal project layout and understand expected output files.
- [Installation](https://hyperlocalise.dev/getting-started/install.md): Installation steps for hyperlocalise, including verification and upgrades.
- [Quickstart](https://hyperlocalise.dev/getting-started/quickstart.md): Run hyperlocalise end-to-end in about 10 minutes.
- [Why Hyperlocalise for AI Localization Workflows](https://hyperlocalise.dev/getting-started/why-hyperlocalise.md): A localization CLI for AI draft generation, TMS curation sync, and Git-friendly translation workflows.
- [What is Hyperlocalise?](https://hyperlocalise.dev/index.md): CLI-first localization workflows for AI draft generation, optional TMS curation sync, and status reporting.
- [Privacy policy](https://hyperlocalise.dev/legal/privacy-policy.md): How Hyperlocalise handles account, usage, and provider-related data.
- [Terms of service](https://hyperlocalise.dev/legal/terms-of-service.md): The baseline terms that govern use of Hyperlocalise websites, docs, and services.
- [Anthropic](https://hyperlocalise.dev/providers/anthropic.md): Configure Anthropic as an LLM provider for translation generation.
- [Azure OpenAI](https://hyperlocalise.dev/providers/azure-openai.md): Configure Azure OpenAI as an LLM provider for translation generation.
- [AWS Bedrock](https://hyperlocalise.dev/providers/bedrock.md): Configure AWS Bedrock as an LLM provider for translation generation.
- [Gemini](https://hyperlocalise.dev/providers/gemini.md): Configure Gemini as an LLM provider for translation generation.
- [Groq](https://hyperlocalise.dev/providers/groq.md): Configure Groq as an LLM provider for translation generation.
- [LM Studio](https://hyperlocalise.dev/providers/lmstudio.md): Configure LM Studio as an LLM provider for translation generation.
- [Ollama](https://hyperlocalise.dev/providers/ollama.md): Configure Ollama as an LLM provider for translation generation.
- [OpenAI](https://hyperlocalise.dev/providers/openai.md): Configure OpenAI as an LLM provider for translation generation.
- [LLM providers overview](https://hyperlocalise.dev/providers/overview.md): Shared profile fields, prompt variables, and links to each provider-specific configuration page.
- [Config schema](https://hyperlocalise.dev/reference/config-schema.md): Concise reference for the hyperlocalise i18n config schema.
- [Creator & Collaborators](https://hyperlocalise.dev/reference/creator.md): About Minh Cung, creator of hyperlocalise and Collaborators
- [Glossary](https://hyperlocalise.dev/reference/glossary.md): Shared terms used across hyperlocalise configuration and workflows.
- [Lockfile contract](https://hyperlocalise.dev/reference/lockfile-contract.md): Understand what `.hyperlocalise.lock.json` stores, when to reset it, and why it is advisory.
- [Output formats](https://hyperlocalise.dev/reference/output-formats.md): Reference for run, status, and sync command output formats.
- [Stability matrix](https://hyperlocalise.dev/reference/stability-matrix.md): Feature maturity levels across provider layer, lockfile flow, TMS adapters, eval, and CI-ready status labels.
- [Crowdin adapter](https://hyperlocalise.dev/storage/crowdin.md): Configure Crowdin for native sync mode or Crowdin-compatible file mode.
- [LILT AI adapter](https://hyperlocalise.dev/storage/lilt.md): Configure LILT AI for remote translation pull/push synchronization.
- [Lokalise adapter](https://hyperlocalise.dev/storage/lokalise.md): Configure Lokalise API v2 for pull/push synchronization.
- [Storage overview](https://hyperlocalise.dev/storage/overview.md): How local files, sidecar metadata, and remote adapters work during sync.
- [Phrase adapter](https://hyperlocalise.dev/storage/phrase.md): Configure Phrase for remote translation synchronization.
- [POEditor adapter](https://hyperlocalise.dev/storage/poeditor.md): Configure POEditor for sync pull and sync push.
- [Smartling adapter](https://hyperlocalise.dev/storage/smartling.md): Configure Smartling for remote translation pull/push synchronization.
- [Common errors](https://hyperlocalise.dev/troubleshooting/common-errors.md): Troubleshoot frequent setup, config, provider, and sync failures.
- [Conflict handling](https://hyperlocalise.dev/troubleshooting/conflicts.md): Understand pull/push conflicts and apply safe resolution strategies.
- [Performance](https://hyperlocalise.dev/troubleshooting/performance.md): Improve runtime and stability on large localization projects.
- [CI automation](https://hyperlocalise.dev/workflows/ci-automation.md): Secure CI patterns for drift checks and scheduled TMS pull/push synchronization.
- [Eval set curation](https://hyperlocalise.dev/workflows/eval-set-curation.md): Build a representative translation evaluation set that catches real quality issues.
- [Local generation workflow](https://hyperlocalise.dev/workflows/local-generation.md): Run draft generation safely and make lock-file behavior predictable.
- [TMS curation loop](https://hyperlocalise.dev/workflows/tms-curation-loop.md): Experimental: Move from local draft generation to human-curated translations and back.

## Optional

- [Hyperlocalise Cloud](https://hyperlocalise.com)
- [GitHub](https://github.com/hyperlocalise/hyperlocalise)
- [Issues](https://github.com/hyperlocalise/hyperlocalise/issues)