Get Started

Module Organization

Modules help organize related translation keys, making large projects manageable and enabling selective exports.

What Are Modules?

Modules group related translation keys:

auth/
├─ login.title
├─ login.subtitle
├─ signup.button
└─ forgot_password.text

dashboard/
├─ welcome.message
├─ stats.title
└─ nav.settings
langctl keys create my-app auth.login.title \
--module auth \
--value-en "Sign In"
langctl keys list my-app --module auth

langctl export my-app -l en --module auth -o auth-en.json

Module-Based Organization

✅ Good module structure:
  - auth (login, signup, password)
  - dashboard (main UI, navigation)
  - settings (user preferences)
  - profile (user info)
  - common (shared strings)

❌ Too many modules:
  - login, signup, forgot-password (combine into "auth")
  - dashboard-main, dashboard-sidebar (combine into "dashboard")

Benefits

  1. Better Organization - Group related keys
  2. Selective Export - Export only needed modules
  3. Team Collaboration - Assign modules to team members
  4. Code Splitting - Load translations on-demand
💡
Tip

Keep modules focused and consistent. Use 5-10 modules for most projects.

Next Steps