github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/cli/README.handlebars (about)

     1  # CLI v2 client for {{packageName}}
     2  
     3  The Phrase Strings Client is available for all major platforms and lets you access all API endpoints as well as easily sync your locale files between your source code and Phrase.
     4  
     5  Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.
     6  
     7  This CLI client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
     8  
     9  - API version: {{appVersion}}
    10  - Package version: {{packageVersion}}
    11  {{^hideGenerationTimestamp}}
    12  - Build date: {{generatedDate}}
    13  {{/hideGenerationTimestamp}}
    14  - Build package: {{generatorClass}}
    15  {{#infoUrl}}
    16  For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
    17  {{/infoUrl}}
    18  
    19  ## Quick Start
    20  
    21  This quick start will guide you through the basic steps to get up and running with the Phrase Strings Client.
    22  
    23  #### 1. Install
    24  
    25  [Download and install](https://phrase.com/cli) the client for your platform. See our [detailed installation guide](https://support.phrase.com/hc/en-us/articles/5784093863964) for more information.
    26  
    27  ##### Homebrew
    28  
    29  If you use homebrew, we have provided a tap to make installation easier on Mac OS X:
    30  
    31          brew install phrase-cli
    32  
    33  The tap is linked to our Formula collection and will be updated, when you call `brew update` as well.
    34  
    35  #### 2. Init
    36  
    37  Initialize your project by executing the `init` command. This lets you define your preferred locale file format, source files and more.
    38  
    39      $ cd /path/to/project
    40      $ phrase init
    41  
    42  When using the US datacenter you need to provide a different API host:
    43  
    44      $ phrase init --host https://api.us.app.phrase.com/v2
    45  
    46  #### 3. Upload your locale files
    47  
    48  Use the `push` command to upload your locale files from your defined [sources](https://support.phrase.com/hc/en-us/articles/5784118494492-Modify-the-CLI-Configuration-File-Strings#push-and-pull-0-0):
    49  
    50      $ phrase push
    51  
    52  #### 4. Download your locale files
    53  
    54  Use the `pull` command to download the most recent locale files back into your project according to your [targets](https://support.phrase.com/hc/en-us/articles/5784118494492-Modify-the-CLI-Configuration-File-Strings#push-and-pull-0-0):
    55  
    56      $ phrase pull
    57  
    58  #### 5. Docker
    59  
    60  You can also use `phrase` through a docker image, without installing the cli on your computer.
    61  
    62      $ docker run --rm phrase/phrase-cli:{{packageVersion}} help
    63  
    64  Some commands are interactive and require the `-it` flag.
    65  
    66      $ docker run -it phrase/phrase-cli:{{packageVersion}} init
    67  
    68  Commands that need to read the config file and write locale files can mount a directory.
    69  
    70      $ docker run --volume $(pwd):/code --workdir /code --rm phrase/phrase-cli:{{packageVersion}} pull
    71  
    72  You can also use the docker image as base for more complex images.
    73  
    74  #### 6. More
    75  
    76  To see a list of all available commands, simply execute:
    77  
    78      $ phrase
    79  
    80  To see all supported options for a command, simple use the `--help` flag:
    81  
    82      $ phrase locales list --help
    83  
    84  See our [detailed guides](https://support.phrase.com/hc/en-us/articles/5808300599068) for in-depth instructions on how to use the Phrase Strings Client.
    85  
    86  ## Contributing
    87  
    88  This tool and it's source code are auto-generated from templates that run against a API specification file. Therefore we can not accept any pull requests in this repository. Please use the GitHub Issue Tracker to report bugs.
    89  
    90  ## Further reading
    91  * [Phrase Strings Client Download Page](https://phrase.com/cli)
    92  
    93  ## Licenses
    94  
    95  phrase-client is licensed under MIT license. (see [LICENSE](LICENSE))
    96  
    97  Parts of phrase-client use third party libraries which are vendored and licensed under different licenses
    98  
    99  ## Author
   100  
   101  support@phrase.com
   102  
   103  ## Get help / support
   104  
   105  Please contact [support@phrase.com](mailto:support@phrase.com?subject=[GitHub]%20phrase-cli) and we can take more direct action toward finding a solution.