Skip to main content
The Together Python library comes with a command-line interface you can use to query Together’s open-source models, upload new data files to your account, or manage your account’s fine-tune jobs.

​
Prerequisites

​
Install the library

Launch your terminal and install or update the Together CLI with the following command: 
pip install --upgrade together

​
Authenticate your shell

The CLI relies on the TOGETHER_API_KEY environment variable being set to your account’s API token to authenticate requests. You can find your API token in your account settings. To create an environment variable in the current shell, run:
Shell
export TOGETHER_API_KEY=xxxxx
You can also add it to your shell’s global configuration so all new sessions can access it. Different shells have different semantics for setting global environment variables, so see your preferred shell’s documentation to learn more.

​
Usage

Shell
# example
together [OPTIONS] COMMAND [ARGS]...

# Usage of inline api key
together --api-key xxx COMMAND [ARGS]...

​
Options

NameOptionDescription
--api-keystringTogether API Key. Defaults to environment variable TOGETHER_API_KEY
--timeoutnumberRequest timeout, defaults to 5 seconds.
--max-retriesnumberMaximum number of HTTP retries.
--versionPrint version
--debugDebug mode
If you know what you’re looking for, find your use case in the sidebar to learn more! The CLI is primarily used for fine-tuning so we recommend visiting Files or Fine-tuning.