Does the CLI support CroQL?

[beshur]

Hi.

Is it possible to use CroQL for source strings management via CLI?
Like in
GET https://api.crowdin.com/api/v2/projects/{projectId}/strings?croql={croql}

I can't find it in the docs.

[andrii-bodnar]

Hi @beshur!

Yes, it's possible using the --croql parameter:

crowdin string list --croql="..."

Also, you can use the -h parameter to see the full options list:

% crowdin string list -h

SYNOPSIS:
crowdin string list [CONFIG OPTIONS] [OPTIONS]

DESCRIPTION:
Show a list of source strings in the current project

OPTIONS:
  -b, --branch=...       Specify branch name. Default: none
  -c, --config=...       Specify a path to the configuration file. Default: crowdin.yml or crowdin.yaml
      --croql=...        Retrieve needed localization resources from Crowdin based on specific conditions
      --file=...         Show a list of source strings filtered by file path
      --filter=...       Show a list of source strings filtered by text and context
  -h, --help             Show this help message and exit
      --identity=...     Specify a path to user-specific credentials
      --no-colors        Disable colors and styles
      --no-progress      Disable progress on executed command
  -v, --verbose          Provide more information on the command execution
  -V, --version          Print version information and exit

CONFIG OPTIONS:
      --base-path=...    Path to your project directory on a local machine
      --base-url=...     Base URL of Crowdin server for API requests execution
  -i, --project-id=...   Numerical ID of the project
  -T, --token=...        Personal access token required for authentication

[beshur]

Thank you! That's great

[beshur]

Probably, it's bash, not crowdin, giving me hard time, but maybe you can help.

% crowdin string list --croql='identifier="apply"'   
✔️  Fetching project info     
❌ Wrong parameters: 
<key: croql, code: croqlInvalidLogic, message: Invalid logic in CroQL. Identifier 'apply' is undefined>

Same with crowdin string list --croql="identifier=\"apply\""

[andrii-bodnar]

@beshur, checked on our side and it seems like there is some issue with the CLI - double quotes are not processing correctly. Will be fixed. Thank you for reporting that

[andrii-bodnar]

For now, you can use the --filter option - it allows strings filtering by identifier, text, or context

[beshur]

Thanks, I'll create an issue then, to subscribe to it.

I will probably use JS API for now, because we have a lot of similar keys, and I'd rather use croQL.