Quick Start - iOS & macOS

Localize your iOS or macOS app with Localazy CLI.

CLI 🔗

Upload Localizable files to Localazy and manage your translations easily. Download translated files back.

1. Install Localazy CLI for your operating system.

2. Create a configuration file localazy.json in the root of your project. You can start with our sample:

.strings 🔗

{

  "writeKey": "your-write-key",
  "readKey": "your-read-key",
  
  "upload": {  
    "type": "ios-strings",
    "files": "Base.lproj/Localizable.strings"
  },
  
  "download": {
    "files": "${iosLprojFolder}/${file}"
  }
  
}

.stringsdict 🔗

{

  "writeKey": "your-write-key",
  "readKey": "your-read-key",
  
  "upload": {  
    "type": "ios-stringsdict",
    "files": "Base.lproj/Localizable.stringsdict"
  },
  
  "download": {
    "files": "${iosLprojFolder}/${file}"
  }
  
}

.plist 🔗

{

  "writeKey": "your-write-key",
  "readKey": "your-read-key",
  
  "upload": {  
    "type": "ios-plist",
    "files": "Base.lproj/Localizable.plist"
  },
  
  "download": {
    "files": "${iosLprojFolder}/${file}"
  }
  
}

3. Upload the source strings with localazy upload whenever you change them.

4. Download translated files with localazy download before building your app.


TIP: Want to use over-the-air updates? Read our Swift SDK guide.


See full iOS/macOS documentation for .strings, .stringsdict, .plist and XLIFF files.

You can upload all your existing translations too! Learn more about it.

SDK 🔗

Integrate our Swift SDK into your iOS app. Deliver translations without publishing new versions to App Store.

1. Upload your source language strings. Follow the CLI quick start, or do it manually in the File management section.

2. Copy the following URL and add it to your Swift Package Dependencies.

https://github.com/localazy/localazy-swift

3. Create Localazy.plist configuration file and add it to your project root.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>readKey</key>
  <string>your-read-key</string>  
</dict>
</plist>

3. Import Localazy library in your project.

#if os(macOS)
import Localazy_macOS
#else
import Localazy_iOS
#endif

5. Get the translated version of your strings by calling:

"Hello".localazyLocalized

Read the complete Usage guide.

Check out How to translate iOS apps tutorial for more useful information.