|
| 1 | +# LRM Cloud Platform |
| 2 | + |
| 3 | +LRM Cloud is a web-based platform for team localization management with real-time collaboration, machine translation, and CLI synchronization. |
| 4 | + |
| 5 | +**[Try LRM Cloud Free](https://lrm-cloud.com)** |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +## Features |
| 10 | + |
| 11 | +- **Web-based Translation Editor** - Edit translations in a spreadsheet-like interface |
| 12 | +- **Multiple Translation Providers** - Google, DeepL, OpenAI, Claude, Azure, and more |
| 13 | +- **Translation Memory** - Automatic caching for cost savings and consistency |
| 14 | +- **Glossary Management** - Enforce consistent terminology across translations |
| 15 | +- **CLI Sync** - Bidirectional sync between local files and cloud |
| 16 | +- **Team Collaboration** - Organizations with role-based access control |
| 17 | +- **Multi-format Support** - RESX, JSON, i18next, Android XML, iOS strings |
| 18 | + |
| 19 | +## Dashboard |
| 20 | + |
| 21 | +The dashboard provides an overview of your localization projects: |
| 22 | + |
| 23 | +- **Project count** and total keys across all projects |
| 24 | +- **Average completion** percentage |
| 25 | +- **LRM Usage** - Translation character consumption |
| 26 | +- **Recent Projects** with quick access to edit and settings |
| 27 | + |
| 28 | +## Projects |
| 29 | + |
| 30 | +Each project contains your localization resources in a specific format. |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | +### Project Overview |
| 35 | + |
| 36 | +The project detail page shows: |
| 37 | + |
| 38 | +- **Key Statistics** - Total keys, languages, completion percentage |
| 39 | +- **Language Progress** - Per-language translation status with progress bars |
| 40 | +- **Project Details** - Format, default language, localization path, sync status |
| 41 | +- **Quick Actions** - Open Editor, View Snapshots, Sync History, Glossary, Translate, Export |
| 42 | + |
| 43 | +### Creating a Project |
| 44 | + |
| 45 | +1. Click **"New Project"** from the dashboard |
| 46 | +2. Enter a project name and slug |
| 47 | +3. Select the resource format (RESX, JSON, i18next, Android, iOS) |
| 48 | +4. Set the default language (source language) |
| 49 | +5. Click **"Create"** |
| 50 | + |
| 51 | +### Importing Existing Resources |
| 52 | + |
| 53 | +You can import resources from: |
| 54 | +- **ZIP archive** - Upload a ZIP containing your localization files |
| 55 | +- **CLI Push** - Use `lrm cloud push` to upload from your local project |
| 56 | + |
| 57 | +## Translation Editor |
| 58 | + |
| 59 | +The web-based editor provides a powerful interface for managing translations. |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +### Features |
| 64 | + |
| 65 | +- **Multi-language Grid** - View all languages side by side |
| 66 | +- **Key Preview Panel** - Detailed view of selected key with all translations |
| 67 | +- **Search & Filter** - Find keys by name, value, or status |
| 68 | +- **Status Indicators** - See which translations are complete, missing, or need review |
| 69 | +- **Bulk Selection** - Select multiple keys for batch operations |
| 70 | +- **Column Visibility** - Show/hide languages as needed |
| 71 | + |
| 72 | +### Editing Translations |
| 73 | + |
| 74 | +1. Click on any cell to select a key |
| 75 | +2. View details in the **Key Preview** panel on the right |
| 76 | +3. Click **"Edit"** to modify values |
| 77 | +4. Changes are saved automatically |
| 78 | + |
| 79 | +### Adding Keys |
| 80 | + |
| 81 | +1. Click **"+ Add Key"** in the toolbar |
| 82 | +2. Enter the key name |
| 83 | +3. Provide the default language value |
| 84 | +4. Optionally add a comment for translators |
| 85 | +5. Click **"Save"** |
| 86 | + |
| 87 | +## Translation |
| 88 | + |
| 89 | +LRM Cloud offers multiple translation options to fit your workflow and budget. |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | +### Translation Providers |
| 94 | + |
| 95 | +| Type | Description | Examples | |
| 96 | +|------|-------------|----------| |
| 97 | +| **LRM Managed** | We handle the API - no key needed | LRM Translation | |
| 98 | +| **BYOK (Bring Your Own Key)** | Use your own API keys | Google, DeepL, OpenAI, Claude, Azure | |
| 99 | +| **Free Providers** | Community providers, no API key | MyMemory, Lingva | |
| 100 | + |
| 101 | +### Translating Keys |
| 102 | + |
| 103 | +1. Select one or more keys in the editor |
| 104 | +2. Click **"Translate"** in the toolbar |
| 105 | +3. Choose the **Translation Provider** |
| 106 | +4. Select **Target Languages** |
| 107 | +5. Configure options: |
| 108 | + - **Only translate missing** - Skip already translated keys |
| 109 | + - **Overwrite existing** - Replace current translations |
| 110 | + - **Context** - Provide context for AI providers |
| 111 | +6. Enable **Translation Memory** options: |
| 112 | + - **Use Translation Memory** - Check TM before calling provider |
| 113 | + - **Store translations in TM** - Save new translations for reuse |
| 114 | + - **Minimum match** - Fuzzy match threshold (100% = exact only) |
| 115 | +7. Click **"Translate All"** |
| 116 | + |
| 117 | +### Configuring Providers |
| 118 | + |
| 119 | +To use your own API keys: |
| 120 | + |
| 121 | +1. Go to **Settings** > **Translation Providers** |
| 122 | +2. Click **"Configure"** on a provider |
| 123 | +3. Enter your API key |
| 124 | +4. Click **"Save & Test"** to verify |
| 125 | + |
| 126 | +Project-level overrides are available in **Project Settings** > **Translation** tab. |
| 127 | + |
| 128 | + |
| 129 | + |
| 130 | +## Translation Memory |
| 131 | + |
| 132 | +Translation Memory (TM) automatically stores translations for reuse, saving costs and ensuring consistency. |
| 133 | + |
| 134 | +### How It Works |
| 135 | + |
| 136 | +1. **TM Check** - Before calling a provider, TM is searched for matches |
| 137 | +2. **Exact Match (100%)** - Reused immediately, no API call needed |
| 138 | +3. **Fuzzy Match (70-99%)** - Suggested based on similarity threshold |
| 139 | +4. **No Match** - Provider is called, result stored in TM |
| 140 | + |
| 141 | +### Benefits |
| 142 | + |
| 143 | +- **Cost Savings** - Avoid redundant API calls |
| 144 | +- **Consistency** - Same text always produces same translation |
| 145 | +- **Speed** - Instant matches from cache |
| 146 | +- **Learning** - TM grows with every translation |
| 147 | + |
| 148 | +### TM Levels |
| 149 | + |
| 150 | +- **Personal TM** - Your individual translations |
| 151 | +- **Organization TM** - Shared across team members (Team/Enterprise plans) |
| 152 | + |
| 153 | +## Glossary |
| 154 | + |
| 155 | +Define approved terminology to ensure consistent translations. |
| 156 | + |
| 157 | +### Use Cases |
| 158 | + |
| 159 | +- **Brand Terms** - Product names that shouldn't be translated |
| 160 | +- **Domain Terminology** - Industry-specific terms |
| 161 | +- **Consistency** - Same term always translates the same way |
| 162 | + |
| 163 | +### Managing Terms |
| 164 | + |
| 165 | +1. Open project **Glossary** from Quick Actions |
| 166 | +2. Click **"Add Term"** |
| 167 | +3. Enter source term and translations per language |
| 168 | +4. Set case sensitivity if needed |
| 169 | +5. Click **"Save"** |
| 170 | + |
| 171 | +Glossary terms are automatically enforced when using AI providers (OpenAI, Claude). |
| 172 | + |
| 173 | +## Sync History |
| 174 | + |
| 175 | +Track all push and revert operations with full audit trail. |
| 176 | + |
| 177 | + |
| 178 | + |
| 179 | +### Viewing History |
| 180 | + |
| 181 | +The Sync History page shows: |
| 182 | +- **Operation ID** - Unique identifier for each push/revert |
| 183 | +- **Type** - Push, revert, or web edit |
| 184 | +- **Timestamp** - When the operation occurred |
| 185 | +- **Changes** - Keys added, modified, or deleted |
| 186 | +- **User** - Who performed the operation |
| 187 | + |
| 188 | +### Reverting Changes |
| 189 | + |
| 190 | +1. Find the push you want to undo in history |
| 191 | +2. Click the **revert** icon |
| 192 | +3. Confirm the revert operation |
| 193 | +4. A new history entry is created for the revert |
| 194 | + |
| 195 | +## CLI Sync |
| 196 | + |
| 197 | +Synchronize local resource files with LRM Cloud using the CLI. |
| 198 | + |
| 199 | +### Quick Start |
| 200 | + |
| 201 | +```bash |
| 202 | +# Clone a cloud project |
| 203 | +lrm cloud clone https://lrm-cloud.com/@username/my-project |
| 204 | + |
| 205 | +# Or link existing project |
| 206 | +lrm remote set https://lrm-cloud.com/@username/my-project |
| 207 | +lrm cloud login |
| 208 | +``` |
| 209 | + |
| 210 | +### Daily Workflow |
| 211 | + |
| 212 | +```bash |
| 213 | +# Pull latest changes |
| 214 | +lrm cloud pull |
| 215 | + |
| 216 | +# Make local changes... |
| 217 | + |
| 218 | +# Push changes to cloud |
| 219 | +lrm cloud push |
| 220 | +``` |
| 221 | + |
| 222 | +### Key Commands |
| 223 | + |
| 224 | +| Command | Description | |
| 225 | +|---------|-------------| |
| 226 | +| `lrm cloud clone <url>` | Clone a cloud project | |
| 227 | +| `lrm cloud push` | Upload local changes | |
| 228 | +| `lrm cloud pull` | Download cloud changes | |
| 229 | +| `lrm cloud status` | Show sync status | |
| 230 | +| `lrm cloud log` | View sync history | |
| 231 | +| `lrm cloud revert <id>` | Undo a previous push | |
| 232 | +| `lrm cloud snapshot create` | Create a named snapshot | |
| 233 | + |
| 234 | +See [Cloud Sync Guide](CLOUD_SYNC.md) for complete documentation. |
| 235 | + |
| 236 | +## Teams & Organizations |
| 237 | + |
| 238 | +Organizations enable team collaboration on localization projects. |
| 239 | + |
| 240 | +### Roles |
| 241 | + |
| 242 | +| Role | Permissions | |
| 243 | +|------|-------------| |
| 244 | +| **Owner** | Full access, billing, delete org | |
| 245 | +| **Admin** | Manage projects, members, settings | |
| 246 | +| **Member** | Edit resources, translate, sync | |
| 247 | +| **Viewer** | View only, export | |
| 248 | + |
| 249 | +### Creating an Organization |
| 250 | + |
| 251 | +1. Go to **Organizations** in the sidebar |
| 252 | +2. Click **"Create Organization"** |
| 253 | +3. Enter name and optional description |
| 254 | +4. Invite team members |
| 255 | + |
| 256 | +## Plans & Pricing |
| 257 | + |
| 258 | +| Feature | Free | Team ($9/mo) | Enterprise ($29/mo) | |
| 259 | +|---------|------|--------------|---------------------| |
| 260 | +| LRM Translation | 5K chars/mo | 50K chars/mo | 500K chars/mo | |
| 261 | +| BYOK Translation | 25K chars/mo | 250K chars/mo | 2.5M chars/mo | |
| 262 | +| Projects | 3 | Unlimited | Unlimited | |
| 263 | +| Team Members | - | 10 | Unlimited | |
| 264 | +| Organizations | - | Yes | Yes | |
| 265 | +| Cloud Storage | 25 MB | 250 MB | 500 MB | |
| 266 | +| Snapshots | 3/project | 10/project | 30/project | |
| 267 | + |
| 268 | +## Getting Started |
| 269 | + |
| 270 | +1. **Create Account** - Sign up at [lrm-cloud.com/app/register](https://lrm-cloud.com/app/register) |
| 271 | +2. **Create Project** - Click "New Project" and configure format |
| 272 | +3. **Import Resources** - Upload ZIP or push via CLI |
| 273 | +4. **Start Translating** - Use the web editor or CLI |
| 274 | + |
| 275 | +## See Also |
| 276 | + |
| 277 | +- [Cloud Sync Guide](CLOUD_SYNC.md) - Complete CLI sync documentation |
| 278 | +- [Cloud Sync Quick Start](CLOUD_SYNC_QUICKSTART.md) - 5-minute quick start |
| 279 | +- [Translation Guide](TRANSLATION.md) - Translation providers and options |
| 280 | +- [Commands Reference](COMMANDS.md) - All CLI commands |
0 commit comments