diff --git a/docs/tooling/cli/03-commands.md b/docs/tooling/cli/03-commands.md index 44b9058f19..7bea50588a 100644 --- a/docs/tooling/cli/03-commands.md +++ b/docs/tooling/cli/03-commands.md @@ -24,7 +24,7 @@ repo [command] Command that run across an entire package [command] Lifecycle scripts for individual packages migrate [command] Migration utilities versions:bump [options] Bump Backstage packages to the latest versions -translations [command] Translation message management +translations [command] Translation message management clean Delete cache directories [DEPRECATED] build-workspace [packages...] Builds a temporary dist workspace from the provided packages @@ -431,8 +431,8 @@ Usage: backstage-cli create-github-app ## translations export -Export translation messages from all frontend plugin dependencies of the current -package. This command must be run from within a package directory (e.g. +Export translation messages from an app and all of its frontend plugins to JSON +files. This command must be run from within a package directory (e.g. `packages/app`), not from the repository root. The command discovers all `TranslationRef` definitions in the dependency tree, diff --git a/packages/cli/src/modules/translations/index.ts b/packages/cli/src/modules/translations/index.ts index 0d7425ad41..702b0f4f49 100644 --- a/packages/cli/src/modules/translations/index.ts +++ b/packages/cli/src/modules/translations/index.ts @@ -24,7 +24,7 @@ export default createCliPlugin({ reg.addCommand({ path: ['translations', 'export'], description: - 'Export translation messages from all frontend plugins to JSON files', + 'Export translation messages from an app and all of its frontend plugins to JSON files', execute: async ({ args }) => { const argv = await yargs() .options({