Command Line Interface¶

3lc is a tool for configuring 3LC, starting the Object Service and managing data, all from the command line. Use --help for a quick guide to available functionality.

Overview¶

  • --config-file: Specifies the path to the configuration file. If this is not set, the tool will look for default locations.

  • login: A sub-command for logging into 3LC by providing an API key, which may be found on the API keys page of your 3LC account. See here for more information.

  • license: A sub-command for checking license status and deactivating the license. Note that license keys are only used in the enterprise on-prem deployment of 3LC. See here for more information.

  • config: A sub-command for inspecting and manipulating the current configuration.

  • service: The main entrypoint to start the Object Service. Additional options like --port and --host can be provided to customize the service behavior.

  • export: A sub-command that allows exporting a table to a file. You can specify the input and output file paths and the format (e.g., CSV).

To see all available configuration options and their current values, run:

3lc config --list

Use --help on any subcommands to get more information about the available options.