### Install Lokalise CLI v2 on Windows using Scoop Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/README.md Install the Lokalise CLI v2 on Windows using the Scoop package manager. First, add the 'extras' bucket to Scoop, then install the CLI. ```bash scoop bucket add extras scoop install lokalise2 ``` -------------------------------- ### Install Lokalise CLI v2 on Linux using Installer Script Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/README.md Execute this script to install the Lokalise CLI v2 on Linux systems, including Raspberry Pi. This method uses curl to download and run the installation script. ```bash curl -sfL https://raw.githubusercontent.com/lokalise/lokalise-cli-2-go/master/install.sh | sh ``` -------------------------------- ### Create Contributor Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor_create.md This is the basic command structure for creating a contributor. Use this as a starting point for all contributor creation commands. ```bash lokalise2 contributor create [flags] ``` -------------------------------- ### Install Lokalise CLI v2 on MacOS using Homebrew Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/README.md Use this command to install the Lokalise CLI v2 on MacOS via Homebrew. Ensure you have Homebrew installed. ```bash brew tap lokalise/cli-2 brew install lokalise2 ``` -------------------------------- ### lokalise2 key update Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_key_update.md This is the basic command structure for updating a key. Use this as a starting point for all update operations. ```bash lokalise2 key update [flags] ``` -------------------------------- ### Help Option Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Display help information for the download command using the `-h` or `--help` flags. ```bash -h, --help help for download ``` -------------------------------- ### List Tasks with Configuration File Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_task_list.md Use a configuration file for project ID and API token. The default configuration file path is './config.yml'. ```bash lokalise2 --config "./config.yml" task list ``` -------------------------------- ### lokalise2 project create command synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project_create.md This is the basic syntax for the create project command. Flags can be added to specify project details. ```bash lokalise2 project create [flags] ``` -------------------------------- ### Delete Translation Status with Flags Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-status_delete.md This example shows the available flags for deleting a translation status, including help, status ID, project ID, and API token. ```bash lokalise2 translation-status delete --help lokalise2 translation-status delete --status-id int lokalise2 translation-status delete --project-id string lokalise2 translation-status delete -t string ``` -------------------------------- ### Create a new Lokalise project Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project_create.md Use this command to create a new project. You must have Admin role in the team. The project name is required. You can optionally specify the project type, base language, and a list of languages to add. ```bash lokalise2 project create --name "My Project" --team-id 12345 --base-lang-iso "en" --languages "[\"en\", \"fr\"]" ``` -------------------------------- ### List Tasks with Project ID and Token Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_task_list.md Specify the project ID and API token directly in the command. This is an alternative to using a configuration file. ```bash lokalise2 --project-id "your_project_id" -t "your_api_token" task list ``` -------------------------------- ### Create Contributor Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor_create.md Creates a contributor in the project. Requires Manage contributors admin right. If `is_admin` flag is set to true, the user would automatically get access to all project languages, overriding supplied languages object. Attribute `fullname` will be ignored, if the user has already been registered in Lokalise. ```APIDOC ## lokalise2 contributor create ### Description Creates a contributor in the project. Requires Manage contributors admin right. If is_admin flag is set to true, the user would automatically get access to all project languages, overriding supplied languages object. Attribute fullname will be ignored, if the user has already been registered in Lokalise. ### Synopsis ``` lokalise2 contributor create [flags] ``` ### Options ``` --admin-rights strings Custom list of user permissions. Possible values are upload, activity, download, settings, statistics, keys, screenshots, contributors, languages. Omitted or empty parameter will set default admin rights for user role. --email string E-mail (required). --fullname string Full name (only valid for inviting users, who previously did not have an account in Lokalise). -h, --help help for create --is-admin Whether the user has Admin access to the project. --is-reviewer Whether the user has Reviewer access to the project. --languages string List of languages, accessible to the user. Required if is_admin is set to false (JSON, see https://lokalise.com/api2docs/curl/#transition-create-contributors-post). ``` ### Options inherited from parent commands ``` --config string config file (default is ./config.yml) --project-id string Unique project identifier (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` ``` -------------------------------- ### lokalise2 snapshot list help flag Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_snapshot_list.md Use the help flag to display information about the list command. ```bash lokalise2 snapshot list -h ``` -------------------------------- ### List Command Configuration Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_list.md These options can be used with the list command to specify the configuration file or API token. ```bash lokalise2 payment-card list --config string lokalise2 payment-card list -t string ``` -------------------------------- ### Create Snapshot Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_snapshot_create.md Use this command to create a snapshot of your project. Ensure you have the 'Manage settings' admin right. You must provide the project ID and can optionally specify a snapshot title. ```bash lokalise2 snapshot create [flags] ``` ```bash --title string Snapshot title. ``` ```bash --config string config file (default is ./config.yml) ``` ```bash --project-id string Unique project identifier (required). ``` ```bash -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### Configuration and Authentication Flags Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user_list.md These flags can be used with the 'list' command for specifying the configuration file path or providing an API token for authentication. ```bash lokalise2 team-user list --config "./config.yml" -t "your_api_token" ``` -------------------------------- ### lokalise2 team list Configuration and Token Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team_list.md These options can be inherited by the list command. Specify a config file or provide an API token for authentication. ```bash lokalise2 team list --config /path/to/config.yml --token YOUR_API_TOKEN ``` -------------------------------- ### Create Snapshot Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_snapshot_create.md Creates a snapshot of the project. Requires Manage settings admin right. ```APIDOC ## lokalise2 snapshot create ### Description Creates snapshot of the project. Requires Manage settings admin right. ### Synopsis ``` lokalise2 snapshot create [flags] ``` ### Options ``` -h, --help help for create --title string Snapshot title. ``` ### Options inherited from parent commands ``` --config string config file (default is ./config.yml) --project-id string Unique project identifier (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` ``` -------------------------------- ### Create Screenshot Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_screenshot_create.md Use this command to create a screenshot in your project. Ensure you have the 'Manage screenshots' admin right. The '--file' flag is required. ```bash lokalise2 screenshot create [flags] ``` -------------------------------- ### lokalise2 Branch Create Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_branch_create.md This is the basic command structure for creating a branch. The `--name` flag is essential for specifying the branch's name. ```bash lokalise2 branch create [flags] ``` -------------------------------- ### Synopsis for listing screenshots Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_screenshot_list.md Use this command to retrieve a list of all screenshots from your project. ```bash lokalise2 screenshot list [flags] ``` -------------------------------- ### Help for List Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_list.md Displays help information for the 'list' subcommand of 'lokalise2 webhook'. ```bash lokalise2 webhook list --help ``` -------------------------------- ### Create Webhook Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_create.md Use this command to create a webhook in your project. Ensure you have the necessary 'Manage settings' admin rights. The `--url` and `--events` flags are required. ```bash lokalise2 webhook create [flags] ``` -------------------------------- ### Synopsis for lokalise2 snapshot list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_snapshot_list.md This is the basic command to list project snapshots. It requires the 'Manage settings' admin right. ```bash lokalise2 snapshot list [flags] ``` -------------------------------- ### Create Webhook Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_create.md Creates a webhook in the project. Requires `Manage settings` admin right. ```APIDOC ## lokalise2 webhook create ### Description Creates a webhook in the project. Requires `Manage settings` admin right. ### Synopsis ``` lokalise2 webhook create [flags] ``` ### Options ``` --branch string If webhook is limited to a single branch --event-lang-map string Map the event with an array of languages iso codes. Omit this parameter for all languages in the project. JSON, see https://lokalise.com/api2docs/curl/#resource-webhooks --events strings List of events to subscribe to (required, see https://developers.lokalise.com/docs/webhook-events). -h, --help help for create --url string Specify the URL to your endpoint (required). ``` ### Options inherited from parent commands ``` --config string config file (default is ./config.yml) --project-id string Unique project identifier (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` ``` -------------------------------- ### lokalise2 snapshot list inherited options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_snapshot_list.md These options can be used with the list command. Specify a config file, project ID, or API token. ```bash lokalise2 snapshot list --config "./config.yml" lokalise2 snapshot list --project-id "unique_project_identifier" lokalise2 snapshot list -t "your_api_token" ``` -------------------------------- ### Configuration File Option Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-status_retrieve-colors.md Specify a custom configuration file path for the lokalise2 CLI. ```bash --config string config file (default is ./config.yml) ``` -------------------------------- ### List Tasks Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_task_list.md Use this command to list all tasks in your Lokalise project. Ensure you have the necessary project ID and API token configured. ```bash lokalise2 task list [flags] ``` -------------------------------- ### List Project Files Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_list.md Lists project files and their associated key count. Unassigned keys are returned with filename __unassigned__. ```bash lokalise2 file list [flags] ``` -------------------------------- ### Lokalise CLI Team Help Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team.md Displays the help message for the 'team' command, outlining its available options. ```bash -h, --help help for team ``` -------------------------------- ### Download Files Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Use this command to export project files as a .zip bundle. The bundle is uploaded to an S3 bucket and remains available for 12 months. Requires the 'Download files' admin right. ```bash lokalise2 file download [flags] ``` -------------------------------- ### Webhook Command Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook.md Lists the available options for the `lokalise2 webhook` command, including the required project ID. ```bash -h, --help help for webhook --project-id string Unique project identifier (required). ``` -------------------------------- ### Directory Prefix Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Set a directory prefix for the bundle using `--directory-prefix` when `original-filenames` is true. The placeholder %LANG_ISO% can be used. ```bash --directory-prefix string Directory prefix in the bundle (used when original-filenames set to true). Allowed placeholder is %LANG_ISO%. ``` -------------------------------- ### Help for List Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_list.md Displays help information for the list command. ```bash lokalise2 file list --help ``` -------------------------------- ### Create a comment with optional flags Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_create.md This command demonstrates adding a comment with inherited options like API token and config file path. The --token flag is recommended for authentication. ```bash lokalise2 comment create --project-id "string" --key-id "int" --comment "string" --token "string" --config "string" ``` -------------------------------- ### Help for List Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_list.md Displays help information for the `language list` command, outlining its specific options. ```bash lokalise2 language list -h ``` -------------------------------- ### Add Projects Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user-group_add-projects.md Specify the group ID and the list of project IDs to add. The team ID and API token are also required for authentication and context. ```bash --group-id int A unique identifier of the group (required). --projects strings List of project IDs to add to group (required). --team-id int A unique identifier of the team (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### Help option for lokalise2 branch list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_branch_list.md Displays help information for the 'list' command within the 'branch' subcommand. ```bash -h, --help help for list ``` -------------------------------- ### Configuration Options for Lokalise CLI Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_list-system.md These options can be used with the `lokalise2 language list-system` command. The project ID is required, while the config file and token can be specified for authentication and configuration. ```bash --config string config file (default is ./config.yml) ``` ```bash --project-id string Unique project identifier (required). ``` ```bash -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### lokalise2 language create Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_create.md This is the basic command structure for creating languages. Use flags to specify language details. ```bash lokalise2 language create [flags] ``` -------------------------------- ### List Webhooks Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_list.md Use this command to retrieve a list of all configured webhooks for your project. Ensure you have the necessary 'Manage settings' admin permissions. ```bash lokalise2 webhook list [flags] ``` -------------------------------- ### List Project Languages Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_list.md Use this command to retrieve a list of languages configured for your project. Ensure you have set up your project ID and API token. ```bash lokalise2 language list [flags] ``` -------------------------------- ### List Providers with Config File Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-provider_list.md Lists translation providers using a specified configuration file. The team ID must be provided. ```bash lokalise2 --config "./config.yml" translation-provider list --team-id 12345 ``` -------------------------------- ### List System Languages Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_list-system.md Use this command to retrieve a list of system languages. Ensure you have the project ID and optionally an API token configured. ```bash lokalise2 language list-system [flags] ``` -------------------------------- ### Bundle Description Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Provide a description for the created bundle using the `--bundle-description` flag. This is applicable for iOS SDK or Android SDK OTA SDK bundles. ```bash --bundle-description string Description of the created bundle. Applies to ios_sdk or android_sdk OTA SDK bundles. ``` -------------------------------- ### Create Translation Order Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_order_create.md Use this command to create a translation order. Ensure you have admin privileges and provide all required parameters such as project ID, provider slug, source and target languages, briefing, card ID, and keys. ```bash lokalise2 order create --project-id "" --provider-slug "" --source-language-iso "" --target-language-isos "" --briefing "" --card-id --keys --keys ``` -------------------------------- ### Translation Command Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation.md Displays available options for the translation command, including help and project ID. ```bash -h, --help help for translation --project-id string Unique project identifier (required). ``` -------------------------------- ### Include All Platforms Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Enable the `--all-platforms` flag to include keys associated with all platforms. If disabled, only keys for the current platform will be exported. ```bash --all-platforms Enable to include all platform keys. If disabled, only the keys, associated with the platform of the format will be exported. ``` -------------------------------- ### Synopsis for lokalise2 team-user-group create Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user-group_create.md This is the basic command structure for creating a team user group. ```bash lokalise2 team-user-group create [flags] ``` -------------------------------- ### Synopsis for Retrieve Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_retrieve.md This is the basic command structure for retrieving a payment card. ```bash lokalise2 payment-card retrieve [flags] ``` -------------------------------- ### Create Screenshot Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_screenshot_create.md Creates a screenshot in the project. Requires Manage screenshots admin right. ```APIDOC ## lokalise2 screenshot create ### Description Creates a screenshot in the project. Requires Manage screenshots admin right. ### Synopsis ``` lokalise2 screenshot create [flags] ``` ### Options #### Command Specific Options - **--description** (string) - Screenshot description. - **--file** (string) - Path to a local image file (required). - **--key-ids** (uints) - Attach the screenshot to key IDs specified. (default []) - **--ocr** (boolean) - Try to recognize translations on the image and attach screenshot to all possible keys. Use `--ocr=false` to disable. (default true). - **--tags** (strings) - List of tags to add to the uploaded screenshot. - **--title** (string) - Screenshot title #### Inherited Options - **--config** (string) - config file (default is ./config.yml) - **--project-id** (string) - Unique project identifier (required). - **-t, --token** (string) - API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### lokalise2 task create Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_task_create.md This is the basic command structure for creating a task. It requires the 'Manage tasks' admin right. ```bash lokalise2 task create [flags] ``` -------------------------------- ### lokalise2 payment-card create Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_create.md Specifies the required card details for creating a new payment card. ```bash --cvc string 3-digit card CVC code (required). --exp-month int Card expiration month (1-12) (required). --exp-year int Card expiration year (required). -h, --help help for create --number string Card number (required). ``` -------------------------------- ### Download Files from Lokalise Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/README.md Use this command to download files from Lokalise. Ensure you provide your API token, project ID, desired format, and a destination directory. ```bash lokalise2 \ --token \ --project-id \ file download \ --format json \ --unzip-to ./locales ``` -------------------------------- ### Include Comments Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Use `--include-comments` to include key comments and descriptions in the exported file, provided the format supports it. ```bash --include-comments Enable to include key comments and description in exported file (if supported by the format). ``` -------------------------------- ### Set Destination Folder Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Use the `--dest` flag to specify the destination folder for the downloaded ZIP file. Defaults to the current directory. ```bash --dest string Destination folder for ZIP file. (default "./") ``` -------------------------------- ### Lokalise CLI Contributor Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor.md Displays the available options for managing contributors. Use this to see available flags and their descriptions. ```bash -h, --help help for contributor --project-id string Unique project identifier (required). ``` ```bash --config string config file (default is ./config.yml) -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### Lokalise CLI Project Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project.md Common options for Lokalise CLI project commands. Use the --config flag to specify a configuration file and the -t or --token flag for API authentication. ```bash -h, --help help for project ``` ```bash --config string config file (default is ./config.yml) ``` ```bash -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### Help for List Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_list.md Displays help information for the `lokalise2 comment list` command. ```bash lokalise2 comment list -h ``` -------------------------------- ### Help for List Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor_list.md Displays help information for the `lokalise2 contributor list` command. ```bash lokalise2 contributor list -h ``` -------------------------------- ### List Project Contributors Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor_list.md Use this command to list all contributors to a project. It displays their access levels to project languages. Admins always have read/write access to all languages. ```bash lokalise2 contributor list [flags] ``` -------------------------------- ### Async File Download Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Use the `--async` flag for asynchronous file downloads. The download link will be active for 24 hours. This mode may become required for large projects. ```bash --async Use async mode for file download. Download link will be active for 24 hours, and json-only param will be ignored if used. From June 1st, 2025 required for projects with >= 10,000 key-language pairs. ``` -------------------------------- ### Bundle Structure Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Define the bundle structure using `--bundle-structure` when `original-filenames` is set to false. Placeholders like %LANG_ISO%, %LANG_NAME%, %FORMAT%, and %PROJECT_NAME% can be used. ```bash --bundle-structure string Bundle structure, used when original-filenames set to false. Allowed placeholders are %LANG_ISO%, %LANG_NAME%, %FORMAT% and %PROJECT_NAME%). ``` -------------------------------- ### List Queued Processes Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_queued-process_list.md Use this command to list all queued processes for a project. Flags can be used to modify the output or specify options. ```bash lokalise2 queued-process list [flags] ``` -------------------------------- ### Delete Project Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project_delete.md This is the basic command structure for deleting a project. Use this to understand the command's entry point. ```bash lokalise2 project delete [flags] ``` -------------------------------- ### Include Description Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Enable `--include-description` to include key descriptions in the exported file. Use `--include-description=false` to disable. Defaults to true. ```bash --include-description Enable to include key description in exported file (if supported by the format) (default true). Use --include-description=false to disable. (default true) ``` -------------------------------- ### Global Options for Lokalise2 CLI Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor_list.md These options can be used with the `lokalise2 contributor list` command and other lokalise2 CLI commands. Specify a config file or API token for authentication and project identification. ```bash --config string config file (default is ./config.yml) ``` ```bash --project-id string Unique project identifier (required). ``` ```bash -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### lokalise2 team list Help Flag Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team_list.md Use the help flag to display information about the list command. ```bash lokalise2 team list --help ``` -------------------------------- ### Retrieve Project Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project_retrieve.md Use this command to retrieve a project. The `--project-id` flag is required. You can also specify an API token using the `-t` or `--token` flag. ```bash lokalise2 project retrieve [flags] ``` ```bash lokalise2 project retrieve --project-id "string" ``` ```bash lokalise2 project retrieve --project-id "string" -t "string" ``` -------------------------------- ### Help Flag for List System Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_list-system.md Displays help information for the `list-system` command. This is a standard flag for most CLI commands. ```bash lokalise2 language list-system -h ``` -------------------------------- ### List Translation Providers Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-provider_list.md Use this command to list all available translation providers configured for your team. Ensure you have authenticated with your API token. ```bash lokalise2 translation-provider list [flags] ``` -------------------------------- ### Synopsis for lokalise2 branch list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_branch_list.md This is the basic command to retrieve a list of project branches. Ensure you have the necessary 'Manage settings' admin right. ```bash lokalise2 branch list [flags] ``` -------------------------------- ### Create a new team user group Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user-group_create.md Use this command to create a new group in the team. You must have Admin rights in the team. Specify the group name and whether it has admin or reviewer access. If the group does not have admin rights, you must specify the languages it can access. ```bash lokalise2 team-user-group create --name "My New Group" --is-admin --team-id 12345 -t "your_api_token" ``` ```bash lokalise2 team-user-group create --name "Translators" --languages "[\"en\", \"es\"]" --team-id 12345 -t "your_api_token" ``` ```bash lokalise2 team-user-group create --name "Admins" --admin-rights "[\"manage_members\", \"manage_projects\"]" --is-admin --team-id 12345 -t "your_api_token" ``` -------------------------------- ### Create a comment for a key Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_create.md Use this command to add a comment to a specific key. Ensure you provide the required --project-id, --key-id, and --comment flags. ```bash lokalise2 comment create --project-id "string" --key-id "int" --comment "string" ``` -------------------------------- ### Upload a File to Lokalise Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/README.md This command uploads a specified file to Lokalise. You need to provide your API token, project ID, the path to the file, and its language ISO code. ```bash lokalise2 \ --token \ --project-id \ file upload \ --file /tmp/en.json \ --lang-iso en ``` -------------------------------- ### Include Project IDs Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Include keys from other projects by specifying their IDs with `--include-pids`. ```bash --include-pids strings Other projects ID's, which keys should be included with this export. ``` -------------------------------- ### Help flag for lokalise2 order list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_order_list.md Use the help flag to display information about the list command's specific options. ```bash lokalise2 order list -h ``` -------------------------------- ### lokalise2 CLI Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_retrieve.md This is the general command structure for retrieving a webhook. The `--webhook-id` flag is required. ```bash lokalise2 webhook retrieve [flags] ``` -------------------------------- ### Synopsis for lokalise2 comment list-key Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_list-key.md This is the basic command structure for listing comments of a key. Use this to initiate the comment listing process. ```bash lokalise2 comment list-key [flags] ``` -------------------------------- ### Dry Run for Order Creation Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_order_create.md Utilize the --dry-run flag to simulate placing an order without actually charging the card or creating the order. This is useful for estimating costs and verifying parameters. ```bash lokalise2 order create --project-id "" --provider-slug "" --source-language-iso "" --target-language-isos "" --briefing "" --card-id --keys --dry-run ``` -------------------------------- ### Options for Create Translation Status Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-status_create.md These are the specific options for the create command. The `--color` and `--title` flags are required to define the new status. ```bash --color string Hex color of the status (required). -h, --help help for create --title string Status title (required). ``` -------------------------------- ### lokalise2 queued-process list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_queued-process_list.md Lists all queued processes for a specified project. Requires a project ID and optionally accepts an API token. ```APIDOC ## lokalise2 queued-process list ### Description Lists all queued processes for a project. ### Method GET ### Endpoint /projects/{project_id}/queued_processes ### Parameters #### Query Parameters - **project_id** (string) - Required - Unique project identifier. - **token** (string) - Optional - API token. You can create API tokens at https://app.lokalise.com/profile. ### Request Example ``` lokalise2 queued-process list --project-id YOUR_PROJECT_ID --token YOUR_API_TOKEN ``` ### Response #### Success Response (200) - **processes** (array) - A list of queued processes. - **id** (string) - The ID of the queued process. - **type** (string) - The type of the queued process. - **status** (string) - The status of the queued process. - **created_at** (string) - The timestamp when the process was created. - **created_by** (object) - Information about the user who created the process. - **id** (string) - The user ID. - **name** (string) - The user's name. - **completed_at** (string) - The timestamp when the process was completed (if applicable). - **error** (string) - Error message if the process failed (if applicable). #### Response Example ```json { "processes": [ { "id": "12345", "type": "translation_import", "status": "completed", "created_at": "2023-10-27T10:00:00Z", "created_by": { "id": "67890", "name": "John Doe" }, "completed_at": "2023-10-27T10:05:00Z" } ] } ``` ``` -------------------------------- ### lokalise2 team list Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team_list.md This is the basic command to list all teams. No specific flags are required for this action. ```bash lokalise2 team list [flags] ``` -------------------------------- ### List Payment Cards Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_list.md Use this command to list all user payment cards. It accepts flags for help and API token configuration. ```bash lokalise2 payment-card list [flags] ``` -------------------------------- ### Inherited Options for Webhook List Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_list.md These options can be used with the 'lokalise2 webhook list' command. Specify the config file, project ID, and API token for authentication and project targeting. ```bash lokalise2 webhook list --config "./config.yml" --project-id "123456" -t "your_api_token" ``` -------------------------------- ### Specify Export Format Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_download.md Use the `--format` flag to specify the desired file format for the export. This flag is required and must be a valid file extension or 'ios_sdk'/'android_sdk' for OTA SDK bundles. ```bash --format string File format (e.g. json, strings, xml). Must be file extension of any of the file formats we support. May also be ios_sdk or android_sdk for respective OTA SDK bundles. (required) ``` -------------------------------- ### Retrieve a Key Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_key_retrieve.md Use this command to retrieve a specific key from your Lokalise project. You must provide a key ID and a project ID. An API token is also required for authentication. ```bash lokalise2 key retrieve --project-id --key-id --token ``` -------------------------------- ### List Project Comments Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_list.md Use this command to retrieve a list of all comments in the project. Ensure you have the project ID and API token configured. ```bash lokalise2 comment list [flags] ``` -------------------------------- ### Help Flag for list command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user_list.md Displays help information for the 'list' command within the 'team-user' module. ```bash lokalise2 team-user list --help ``` -------------------------------- ### Retrieve Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_queued-process_retrieve.md These are the specific options available for the retrieve command. The process ID is mandatory. ```bash -h, --help help for retrieve --process-id string A unique identifier of the process (required). ``` -------------------------------- ### Inherited Command Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook.md Details options inherited from parent commands, such as specifying a configuration file or an API token for authentication. ```bash --config string config file (default is ./config.yml) -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### lokalise2 translation list command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation_list.md Use this command to list all translations in a project. Consider using the Keys resource for structured key/translation pairs. ```bash lokalise2 translation list [flags] ``` -------------------------------- ### Inherited Options for lokalise2 commands Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_list-key.md These options are inherited from parent commands and apply to 'list-key'. They include configuration file path, project ID, and API token. ```bash --config string config file (default is ./config.yml) --project-id string Unique project identifier (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### lokalise2 payment-card create Flags Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_create.md These are the available flags for the `create` command. The card number, expiration month, expiration year, and CVC are mandatory. ```bash lokalise2 payment-card create [flags] ``` -------------------------------- ### Synopsis for Retrieve Order Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_order_retrieve.md This is the basic command structure for retrieving an order. Flags can be added to specify the order ID and authentication details. ```bash lokalise2 order retrieve [flags] ``` -------------------------------- ### lokalise2 Branch Create Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_branch_create.md These are the specific flags available for the create branch command. The `--name` flag is used to set the branch name. ```bash lokalise2 branch create --name string -h, --help help for create ``` -------------------------------- ### Synopsis of lokalise2 order list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_order_list.md This is the basic command to list all translation orders in the team. Use flags to filter or modify the output. ```bash lokalise2 order list [flags] ``` -------------------------------- ### Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_retrieve.md This is the basic syntax for the retrieve language command. Flags for language ID and project ID are required. ```bash lokalise2 language retrieve [flags] ``` -------------------------------- ### lokalise2 CLI Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_retrieve.md Available flags for the retrieve command, including the required `--webhook-id`. ```bash lokalise2 webhook retrieve [flags] Options: -h, --help help for retrieve --webhook-id string A unique identifier of the webhook (required). ``` -------------------------------- ### lokalise2 team-user-group add-projects Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user-group_add-projects.md Use this command to add projects to a specified group. Ensure you provide the group ID, team ID, and a list of project IDs. ```bash lokalise2 team-user-group add-projects [flags] ``` -------------------------------- ### List Command Help Flag Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_list.md This flag provides help information for the list command. ```bash lokalise2 payment-card list --help ``` -------------------------------- ### Contributor Creation Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_contributor_create.md These flags configure the contributor's role and access. The email is required. Use --is-admin for full project access or specify languages for granular control. ```bash --admin-rights strings Custom list of user permissions. Possible values are upload, activity, download, settings, statistics, keys, screenshots, contributors, languages. Omitted or empty parameter will set default admin rights for user role. --email string E-mail (required). --fullname string Full name (only valid for inviting users, who previously did not have an account in Lokalise). -h, --help help for create --is-admin Whether the user has Admin access to the project. --is-reviewer Whether the user has Reviewer access to the project. --languages string List of languages, accessible to the user. Required if is_admin is set to false (JSON, see https://lokalise.com/api2docs/curl/#transition-create-contributors-post). ``` -------------------------------- ### List Projects Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project_list.md Use this command to retrieve a list of all projects accessible with your API token. You can filter results by project name or team ID, and control the inclusion of project settings and statistics. ```bash lokalise2 project list [flags] ``` -------------------------------- ### Lokalise CLI Branch Command Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_branch.md Displays the available options for the 'lokalise2 branch' command. Use these flags to configure branch operations. ```bash -h, --help help for branch --project-id string Unique project identifier (required). ``` -------------------------------- ### Synopsis for lokalise2 translation retrieve Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation_retrieve.md This is the basic command structure for retrieving a translation. Use this to understand the command's entry point. ```bash lokalise2 translation retrieve [flags] ``` -------------------------------- ### Help Flag for Retrieve Colors Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-status_retrieve-colors.md Use the help flag to display information about the `retrieve-colors` command. ```bash lokalise2 translation-status retrieve-colors --help ``` -------------------------------- ### lokalise2 file upload command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_upload.md This is the base command for uploading files. Use flags to specify options. ```bash lokalise2 file upload [flags] ``` -------------------------------- ### List Projects Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_project_list.md Retrieves a list of projects available to the user, authorized with a token. ```APIDOC ## lokalise2 project list ### Description Retrieves a list of projects available to the user, authorized with a token. ### Synopsis ``` lokalise2 project list [flags] ``` ### Options #### Flags - `--filter-names string` - One or more project names to filter by. - `--filter-team-id int` - Limit results to team ID. - `-h, --help` - help for list - `--include-settings uint8` - Whether to include project settings. (default 1) - `--include-statistics uint8` - Whether to include project statistics. (default 1) #### Inherited Options - `--config string` - config file (default is ./config.yml) - `-t, --token string` - API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### Retrieve a Task Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_task_retrieve.md Use this command to retrieve a specific task. You must provide the task ID and project ID. An API token can also be supplied. ```bash lokalise2 task retrieve --project-id "string" --task-id int ``` -------------------------------- ### Task Retrieve Command Synopsis Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_task_retrieve.md This is the basic syntax for retrieving a task. Ensure you have the required flags. ```bash lokalise2 task retrieve [flags] ``` -------------------------------- ### Synopsis for lokalise2 team-user list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user_list.md This is the basic command structure for listing team users. It requires the team ID and optionally accepts an API token. ```bash lokalise2 team-user list [flags] ``` -------------------------------- ### Create Payment Card Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_payment-card_create.md Use this command to add a new payment card. Ensure all required flags like card number, expiration month, expiration year, and CVC are provided. ```bash lokalise2 payment-card create --number "4111111111111111" --exp-month 12 --exp-year 2025 --cvc "123" ``` -------------------------------- ### Add Members Command Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user-group_add-members.md Specifies the required group ID and a list of user IDs to add to the group. The help flag provides usage information. ```bash --group-id int A unique identifier of the group (required). -h, --help help for add-members --users ints List of user IDs to add to group (required). ``` -------------------------------- ### lokalise2 snapshot list Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_snapshot_list.md Retrieves a list of project snapshots. Requires Manage settings admin right. ```APIDOC ## lokalise2 snapshot list ### Description Retrieves a list of project snapshots. Requires Manage settings admin right. ### Synopsis ``` lokalise2 snapshot list [flags] ``` ### Options #### Command Specific Options ``` -h, --help help for list ``` #### Inherited Options ``` --config string config file (default is ./config.yml) --project-id string Unique project identifier (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` ``` -------------------------------- ### Options for lokalise2 team-user-group create Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_team-user-group_create.md These are the specific flags available for creating a team user group, including name, admin rights, reviewer status, and language associations. ```bash --admin-rights strings List of group administrative permissions. Required if group has admin rights. --is-admin Whether the group has Admin access to the project (required). --is-reviewer Whether the group has reviewer access to the project (required). --languages string List of languages. Required if group doesn't have admin rights. JSON, see https://lokalise.com/api2docs/curl/#transition-create-a-group-post --name string Name of the group (required). ``` -------------------------------- ### Inherited Options for List Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_comment_list.md These options can be used with the `lokalise2 comment list` command. The project ID is required. ```bash lokalise2 --config string lokalise2 --project-id string lokalise2 -t string ``` -------------------------------- ### List Webhooks Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_webhook_list.md Retrieves a list of all configured webhooks for the project. This operation requires the 'Manage settings' admin right. ```APIDOC ## lokalise2 webhook list ### Description Retrieves a list of configured webhooks. Requires `Manage settings` admin right. ### Synopsis ``` lokalise2 webhook list [flags] ``` ### Options #### Query Parameters - `--config` (string) - Optional - config file (default is ./config.yml) - `--project-id` (string) - Required - Unique project identifier. - `-t, --token` (string) - Optional - API token. You can create API tokens at https://app.lokalise.com/profile. ### SEE ALSO * [lokalise2 webhook](lokalise2_webhook.md) - Manage webhooks ``` -------------------------------- ### List System Languages Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_language_list-system.md Retrieves a list of system languages available in your Lokalise project. This command requires a project ID and optionally accepts an API token. ```APIDOC ## lokalise2 language list-system ### Description Retrieves a list of system languages. ### Synopsis ``` lokalise2 language list-system [flags] ``` ### Options ``` -h, --help help for list-system ``` ### Options inherited from parent commands ``` --config string config file (default is ./config.yml) --project-id string Unique project identifier (required). -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` ### SEE ALSO * [lokalise2 language](lokalise2_language.md) - Manage languages ``` -------------------------------- ### Parent Command Options Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_file_upload.md These options are inherited from parent commands and are common across multiple lokalise2 commands, such as specifying the configuration file or project ID. ```bash --config string config file (default is ./config.yml) ``` ```bash --project-id string Unique project identifier (required). ``` ```bash -t, --token string API token. You can create API tokens at https://app.lokalise.com/profile. ``` -------------------------------- ### Create Branch Command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_branch_create.md Use this command to create a new branch in your Lokalise project. Ensure you have the 'Manage settings' admin right. The project ID is a required parameter. ```bash lokalise2 branch create --name "New Feature Branch" --project-id "123456" ``` -------------------------------- ### Screenshot Creation Flags Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_screenshot_create.md These flags customize the screenshot creation process, including setting a description, attaching to specific keys, enabling OCR, and adding tags. ```bash --description string Screenshot description. --file string Path to a local image file (required). -h, --help help for create --key-ids uints Attach the screenshot to key IDs specified. (default []) --ocr Try to recognize translations on the image and attach screenshot to all possible keys (default true). Use --ocr=false to disable. (default true). --tags strings List of tags to add to the uploaded screenshot. --title string Screenshot title ``` -------------------------------- ### Help for translation-status command Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_translation-status.md Displays help information for the translation-status command, including its options. ```bash lokalise2 translation-status --help ``` -------------------------------- ### List Screenshots Source: https://github.com/lokalise/lokalise-cli-2-go/blob/main/docs/lokalise2_screenshot_list.md Retrieves a list of screenshots from the project. Requires a project ID and optionally an API token. ```APIDOC ## lokalise2 screenshot list ### Description Retrieves a list of screenshots from the project. ### Synopsis ``` lokalise2 screenshot list [flags] ``` ### Options #### Inherited Options - `--config` (string) - config file (default is ./config.yml) - `--project-id` (string) - Unique project identifier (required). - `-t, --token` (string) - API token. You can create API tokens at https://app.lokalise.com/profile. ```