ContextQMD
Back to Openspec

Multi-Language Guide

docs/multi-language.md

1.10.02.7 KB
Original Source

Multi-Language Guide

Configure OpenSpec to generate artifacts in languages other than English.

Quick Setup

For a new project, set the language during initialization:

bash
openspec init --language "Portuguese (pt-BR)"

This writes the language instruction to openspec/config.yaml. If the project already has a config, edit its context field directly so existing project guidance is preserved.

You can also configure the same behavior manually:

Add a language instruction to your openspec/config.yaml:

yaml
schema: spec-driven

context: |
  Language: Portuguese (pt-BR)
  All artifacts must be written in Brazilian Portuguese.
  Keep OpenSpec structural headings and SHALL/MUST keywords in English.

  # Your other project context below...
  Tech stack: TypeScript, React, Node.js

That's it. All generated artifacts will now be in Portuguese.

OpenSpec's document structure and normative SHALL/MUST keywords remain in English because validation relies on them. The surrounding requirement and scenario prose can use your selected language.

Language Examples

Portuguese (Brazil)

yaml
context: |
  Language: Portuguese (pt-BR)
  All artifacts must be written in Brazilian Portuguese.

Spanish

yaml
context: |
  Idioma: Español
  Todos los artefactos deben escribirse en español.

Chinese (Simplified)

yaml
context: |
  语言：中文（简体）
  所有产出物必须用简体中文撰写。

Japanese

yaml
context: |
  言語：日本語
  すべての成果物は日本語で作成してください。

French

yaml
context: |
  Langue : Français
  Tous les artefacts doivent être rédigés en français.

German

yaml
context: |
  Sprache: Deutsch
  Alle Artefakte müssen auf Deutsch verfasst werden.

Tips

Handle Technical Terms

Decide how to handle technical terminology:

yaml
context: |
  Language: Japanese
  Write in Japanese, but:
  - Keep technical terms like "API", "REST", "GraphQL" in English
  - Code examples and file paths remain in English

Combine with Other Context

Language settings work alongside your other project context:

yaml
schema: spec-driven

context: |
  Language: Portuguese (pt-BR)
  All artifacts must be written in Brazilian Portuguese.

  Tech stack: TypeScript, React 18, Node.js 20
  Database: PostgreSQL with Prisma ORM

Verification

To verify your language config is working:

bash
# Check the instructions - should show your language context
openspec instructions proposal --change my-change

# Output will include your language context