OS Manuals

/usr/bin/gen_client

Toolbox for GitLab CE FIPS 18.10

From gitlab-toolbox-ce-fips-18.10 18.10.8-r0 (enterprise-packages), captured 2026-11-08 by running gen_client --help (exit 0). permalink

usage: gen_client [-h] [--infile INFILE | --discovery_url DISCOVERY_URL]
                  [--base_package BASE_PACKAGE] [--protorpc_package PROTORPC_PACKAGE]
                  [--version-identifier VERSION_IDENTIFIER] [--outdir OUTDIR] [--overwrite]
                  [--root_package ROOT_PACKAGE] [--strip_prefix [STRIP_PREFIX ...]]
                  [--api_key API_KEY] [--client_json CLIENT_JSON] [--client_id CLIENT_ID]
                  [--client_secret CLIENT_SECRET] [--scope [SCOPE ...]] [--user_agent USER_AGENT]
                  [--generate_cli] [--nogenerate_cli] [--init-file {none,empty,wildcards}]
                  [--unelidable_request_methods UNELIDABLE_REQUEST_METHODS]
                  [--apitools_version APITOOLS_VERSION] [--experimental_capitalize_enums]
                  [--experimental_name_convention {LOWER_CAMEL,LOWER_WITH_UNDER,NONE}]
                  [--experimental_proto2_output]
                  {client,pip_package,proto} ...

Apitools Client Code Generator

positional arguments:
  {client,pip_package,proto}
                        Type of generated code
    client              Generate apitools client in destination folder
    pip_package         Generate apitools client pip package
    proto               Generate apitools client protos

options:
  -h, --help            show this help message and exit
  --infile INFILE       Filename for the discovery document. Mutually exclusive with
                        --discovery_url
  --discovery_url DISCOVERY_URL
                        URL (or "name.version") of the discovery document to use. Mutually
                        exclusive with --infile.
  --base_package BASE_PACKAGE
                        Base package path of apitools (defaults to apitools.base.py
  --protorpc_package PROTORPC_PACKAGE
                        Base package path of protorpc (defaults to apitools.base.protorpclite
  --version-identifier VERSION_IDENTIFIER
                        Version identifier to use for the generated client (defaults to "version"
                        value in discovery doc). This must be a valid identifier when used in a
                        Python module name.
  --outdir OUTDIR       Directory name for output files. (Defaults to the API name.)
  --overwrite           Only overwrite the output directory if this flag is specified.
  --root_package ROOT_PACKAGE
                        Python import path for where these modules should be imported from.
  --strip_prefix [STRIP_PREFIX ...]
                        Prefix to strip from type names in the discovery document. (May be
                        specified multiple times.)
  --api_key API_KEY     API key to use for API access.
  --client_json CLIENT_JSON
                        Use the given file downloaded from the dev. console for client_id and
                        client_secret.
  --client_id CLIENT_ID
                        Client ID to use for the generated client.
  --client_secret CLIENT_SECRET
                        Client secret for the generated client.
  --scope [SCOPE ...]   Scopes to request in the generated client. May be specified more than
                        once.
  --user_agent USER_AGENT
                        User agent for the generated client. Defaults to <api>-generated/0.1.
  --generate_cli        Ignored.
  --nogenerate_cli      Ignored.
  --init-file {none,empty,wildcards}
                        Controls whether and how to generate package __init__.py file.
  --unelidable_request_methods UNELIDABLE_REQUEST_METHODS
                        Full method IDs of methods for which we should NOT try to elide the
                        request type. (Should be a comma-separated list.
  --apitools_version APITOOLS_VERSION
                        Apitools version used as a requirement in generated clients. Defaults to
                        version of apitools used to generate the clients.
  --experimental_capitalize_enums
                        Dangerous: attempt to rewrite enum values to be uppercase.
  --experimental_name_convention {LOWER_CAMEL,LOWER_WITH_UNDER,NONE}
                        Dangerous: use a particular style for generated names.
  --experimental_proto2_output
                        Dangerous: also output a proto2 message file.
Options (23)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--infile INFILEFilename for the discovery document.help
--discovery_url DISCOVERY_URLURL (or "name.version") of the discovery document to use.help
--base_package BASE_PACKAGEBase package path of apitools (defaults to apitools.base.pyhelp
--protorpc_package PROTORPC_PACKAGEBase package path of protorpc (defaults to apitools.base.protorpclitehelp
--version-identifier VERSION_IDENTIFIERVersion identifier to use for the generated client (defaults to "version" value in discovery doc).help
--outdir OUTDIRDirectory name for output files.help
--overwriteOnly overwrite the output directory if this flag is specified.help
--root_package ROOT_PACKAGEPython import path for where these modules should be imported from.help
--api_key API_KEYAPI key to use for API access.help
--client_json CLIENT_JSONUse the given file downloaded from the dev.help
--client_id CLIENT_IDClient ID to use for the generated client.help
--client_secret CLIENT_SECRETClient secret for the generated client.help
--scope SCOPEScopes to request in the generated client.help
--user_agent USER_AGENTUser agent for the generated client.help
--generate_cliIgnored.help
--nogenerate_cliIgnored.help
--init-file noneControls whether and how to generate package __init__.py file.help
--unelidable_request_methods UNELIDABLE_REQUEST_METHODSFull method IDs of methods for which we should NOT try to elide the request type.help
--apitools_version APITOOLS_VERSIONApitools version used as a requirement in generated clients.help
--experimental_capitalize_enumsDangerous: attempt to rewrite enum values to be uppercase.help
--experimental_name_convention LOWER_CAMELDangerous: use a particular style for generated names.help
--experimental_proto2_outputDangerous: also output a proto2 message file.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.