@localess/cli 0.0.1-dev.20260216094809 → 0.0.1-dev.20260216101417

package/README.md

@@ -8,55 +8,54 @@
 
 # Localess Command Line
 
-This client SDK is designed to work with the Localess API. It provides a simple way to interact with the Localess API from your JavaScript or TypeScript application.
-
-> **Important:** 
-> The Client is designed to be used on the server side only, as it requires your **Localess API Token** to be kept secret.
-> Do not use this client in your frontend application, as it exposes your API Token to the public.
-
-## Installation
-
-### NPM
-````bash
-npm install @localess/js-client@latest
-````
-
-### Yarn
-````bash
-yarn add @localess/js-client@latest
-````
-
-## Client
-
-````ts
-import {localessClient} from "@localess/js-client";
-
-const llClient = localessClient({
-  // A fully qualified domain name with protocol (http/https) and port.
-  origin: 'https://my-localess.web.app',
-  // Localess space ID, cna be found in the Localess Space settings
-  spaceId: 'I1LoVe2LocaLess4Rever',
-  // Localess API token, can be found in the Localess Space settings
-  token: 'Baz00KaT0KeN8S3CureLL'
-});
-
-// Fetch all Content Links
-llClient.getLinks()
-// Fetch content by SLUG
-llClient.getContentBySlug('docs/overview')
-// Fetch content by ID
-llClient.getContentById('FRnIT7CUABoRCdSVVGGs')
-// Fetch translations by locale
-llClient.getTranslations('en') 
-````
-
-## Sync with Visual Editor
-
-It will automatically inject Localess Sync Script in to the HTML page.
-
-````ts
-import {loadLocalessSync} from "@localess/js-client";
-
-// A fully qualified domain name with protocol (http/https) and port.
-loadLocalessSync('https://my-localess.web.app')
-````
+A powerful CLI tool to interact with your Localess spaces.
+
+## Features
+
+- 🔐 **Authentication** - Secure login system and CI environments.
+- 🛡️ **Type Safety** - Generate TypeScript type definitions for your Localess content schemas, ensuring type safety in your frontend applications.
+- 🌐 **Translations** - Sync and manage translations for your Localess space.
+
+## Setup
+
+```bash
+npm install @localess/cli -D
+```
+
+## Login
+The CLI provides a `login` command to authenticate with your Localess account. This command prompts you for your email and password, and securely stores an authentication token for future API requests.
+### Usage
+
+#### Login with your Localess from CLI:
+```bash
+localess login --origin <localess_api_origin> --space <space_id> --token <space_access_token>
+```
+#### Login with your Localess with environment variables:
+```bash
+export LOCALESS_ORIGIN=<localess_api_origin>
+export LOCALESS_SPACE=<space_id>
+export LOCALESS_TOKEN=<space_access_token>  
+localess login
+```
+
+## Logout
+The CLI provides a `logout` command to clear your authentication token and log you out of your Localess account.
+### Usage
+```bash
+localess logout
+```
+
+## Generate TypeScript Types
+
+The CLI provides a `types` command to generate TypeScript definitions for your Localess content schemas. This command fetches your space's OpenAPI schema and writes a `localess.d.ts` file to your project, allowing for strong typing in your codebase.
+
+### Usage
+
+```bash
+localess types
+```
+
+- You must be logged in (`localess login`) before running this command.
+- The generated types file will be saved as `./.localess/localess.d.ts` in your current working directory.
+
+You can then import these types in your TypeScript project for improved type safety when working with Localess content.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localess/cli",
-  "version": "0.0.1-dev.20260216094809",
+  "version": "0.0.1-dev.20260216101417",
   "description": "Localess Command Line.",
   "keywords": [
     "localess",