Terality Docs
  • What is Terality?
  • Documentation
    • Quickstart
      • Setup
      • Tutorial
      • Next steps
    • User guide
      • Supported configurations
      • User dashboard
      • Importing and exporting data
        • Reading/writing to storage
        • Reading from multiple files
        • Writing to multiple files
        • Storage services
        • Data formats
        • From/to pandas
      • .apply() and passing callables
      • Caching
      • Best practices and anti-patterns
      • Upgrading your client version
      • Client configuration (CLI)
      • Support for external packages
      • Advanced topics
        • Data mutability and ownership: Terality vs pandas
    • API Reference
      • Conversion from/to pandas
      • Write to multiple files
    • Deploy Terality in your own AWS account
    • Releases
  • FAQ
    • Differences with
      • Terality and Pandas
      • Terality vs Spark
      • Terality vs Dask
    • Pricing
    • Security
    • Support & contact
    • Common setup issues
Powered by GitBook
On this page
  • Usage
  • Examples
  • Account management: get a list of available commands
  • Configure your laptop with your Terality credentials
  • Display the current Terality account configuration

Was this helpful?

  1. Documentation
  2. User guide

Client configuration (CLI)

The terality Python package comes with a command line interface (CLI) that you can use to configure the Terality client on your machine.

You can run it by typing terality in your shell (not in a Python interpreter).

If you installed the Terality Python package in a virtual environment, you must activate this virtual environment before running the terality CLI.

If you encounter the error: terality: command not found, try using the alias python -m terality instead. For instance, replace terality account create with python -m terality account create.

Usage

To get a list of the available commands, run:

$ terality --help

Currently, this CLI only exposes features related to account management.

Examples

Account management: get a list of available commands

$ terality account --help

Configure your laptop with your Terality credentials

$ terality account configure

Display the current Terality account configuration

$ terality account info
PreviousUpgrading your client versionNextSupport for external packages

Last updated 3 years ago

Was this helpful?