mirror/api

mirror of https://github.com/unraid/api.git synced 2026-01-01 06:01:18 -06:00

Files

Eli Bosley 31c41027fc feat: translations now use crowdin (translate.unraid.net) (#1739 )

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- App-wide internationalization: dynamic locale detection/loading, many
new locale bundles, and CLI helpers to extract/sort translation keys.

- **Accessibility**
  - Brand button supports keyboard activation (Enter/Space).

- **Documentation**
  - Internationalization guidance added to API and Web READMEs.

- **Refactor**
- UI updated to use centralized i18n keys and a unified locale loading
approach.

- **Tests**
  - Test utilities updated to support i18n and localized assertions.

- **Chores**
- Crowdin config and i18n scripts added; runtime locale exposed for
selection.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2025-10-13 16:56:08 -04:00

2.1 KiB

Raw Blame History

@unraid/api

Installation

Install the production plugin via the apps tab (search for "Unraid Connect")

Manual install can be done with the following routes: production staging

CLI

If you're on a unraid v6.9.2 or later machine this should be available by running unraid-api in any directory.

root@Devon:~# unraid-api

Unraid API

  Thanks for using the official Unraid API

Usage:

  $ unraid-api command <options>

Commands:

  start/stop/restart/version/status/report/switch-env

Options:

  -h, --help                                                   Prints this usage guide.
  -d, --debug                                                  Enabled debug mode.
  -p, --port string                                            Set the graphql port.
  --environment production/staging/development                 Set the working environment.
  --log-level ALL/TRACE/DEBUG/INFO/WARN/ERROR/FATAL/MARK/OFF   Set the log level.

  Copyright © 2024 Lime Technology, Inc.

Key

To create and work with Unraid API keys, used for the local API, run the following command to view all available options. These options may change over time.

unraid-api key --help

Report

To view the current status of the unraid-api and its connection to mothership, run:

unraid-api report

To view verbose data (anonymized), run:

unraid-api report -v

To view non-anonymized verbose data, run:

unraid-api report -vv

Secrets

If you found this file you're likely a developer. If you'd like to know more about the API and when it's available please join our discord.

Internationalization

Run pnpm --filter @unraid/api i18n:extract to scan the Nest.js source for translation helper usages and update src/i18n/en.json with any new keys. The extractor keeps existing translations intact and appends new keys with their English source text.

2.1 KiB Raw Blame History