ReddRadar
Agent skill
lokalise-install-auth
Install and configure Lokalise SDK/CLI authentication. Use when setting up a new Lokalise integration, configuring API tokens, or initializing Lokalise in your project. Trigger with phrases like "install lokalise", "setup lokalise", "lokalise auth", "configure lokalise API token".
Stars
163
Forks
31
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/lokalise-install-auth
SKILL.md
Lokalise Install & Auth
Overview
Set up Lokalise SDK/CLI and configure API token authentication for translation management.
Prerequisites
- Node.js 14+ (v18+ recommended for ESM support)
- Package manager (npm, pnpm, or yarn)
- Lokalise account with project access
- API token from Lokalise profile settings
Instructions
Step 1: Install Node.js SDK
bash
# Node.js SDK (ESM module, v9+)
npm install @lokalise/node-api
# For CommonJS projects, use v8
npm install @lokalise/node-api@8
Step 2: Install CLI Tool (Optional)
bash
# macOS via Homebrew
brew tap lokalise/cli-2
brew install lokalise2
# Linux/Windows via direct download
# Visit: https://github.com/lokalise/lokalise-cli-2-go/releases
# Verify installation
lokalise2 --version
Step 3: Generate API Token
- Log into Lokalise
- Click profile avatar -> Profile Settings
- Go to "API tokens" tab
- Click "Generate new token"
- Choose "Read and write" for full access
- Copy the token immediately (shown only once)
Step 4: Configure Authentication
bash
# Set environment variable
export LOKALISE_API_TOKEN="your-api-token"
# Or create .env file
echo 'LOKALISE_API_TOKEN=your-api-token' >> .env
# CLI configuration (creates ~/.lokalise2/config.yml)
lokalise2 --token "$LOKALISE_API_TOKEN" project list
Step 5: Verify Connection
typescript
import { LokaliseApi } from "@lokalise/node-api";
const lokaliseApi = new LokaliseApi({
apiKey: process.env.LOKALISE_API_TOKEN!,
});
// Test connection by listing projects
const projects = await lokaliseApi.projects().list();
console.log(`Connected! Found ${projects.items.length} projects.`);
Output
- Installed
@lokalise/node-apipackage - Optional:
lokalise2CLI installed - Environment variable or .env file with API token
- Successful connection verification
Error Handling
| Error | Cause | Solution |
|---|---|---|
401 Unauthorized |
Invalid or expired token | Generate new token in profile settings |
403 Forbidden |
Token lacks required permissions | Use read-write token, not read-only |
ERR_REQUIRE_ESM |
Using require() with SDK v9+ | Use ESM imports or downgrade to v8 |
ENOTFOUND api.lokalise.com |
Network blocked | Check firewall allows outbound HTTPS |
Examples
TypeScript Setup (ESM)
typescript
import { LokaliseApi } from "@lokalise/node-api";
const lokaliseApi = new LokaliseApi({
apiKey: process.env.LOKALISE_API_TOKEN!,
});
// List all projects
const projects = await lokaliseApi.projects().list();
projects.items.forEach(p => console.log(`${p.project_id}: ${p.name}`));
CommonJS Setup (SDK v8)
javascript
const { LokaliseApi } = require("@lokalise/node-api");
const lokaliseApi = new LokaliseApi({
apiKey: process.env.LOKALISE_API_TOKEN,
});
lokaliseApi.projects().list().then(projects => {
console.log(`Found ${projects.items.length} projects`);
});
CLI Configuration File
yaml
# ~/.lokalise2/config.yml
token: "your-api-token"
project_id: "123456789.abcdef"
OAuth2 Authentication (for apps)
typescript
import { LokaliseApiOAuth } from "@lokalise/node-api";
// Use token obtained via OAuth2 flow
const lokaliseApi = new LokaliseApiOAuth({
apiKey: oauthAccessToken,
});
Resources
Next Steps
After successful auth, proceed to lokalise-hello-world for your first API call.
Didn't find tool you were looking for?