TFS CLI

TFS CLI is a command-line interface designed to simplify file sharing directly from your terminal. With TFS CLI, you can effortlessly upload, download, and manage files without leaving the command line.

Table of Contents

• TFS CLI
• Table of Contents
• Installation
• Configuration
  • Authentication Token
  • Encryption Key (Optional)
• Usage Examples
  • Pushing a File
  • Pulling a File
• Documentation
• Contributing
• Credits
• License

Installation

Install TFS CLI globally via npm:

npm install -g @ownage-fdt/tfs-cli

After installation, running tfs in your terminal should display output similar to the following:

VERSION
  @ownage-fdt/tfs-cli/1.0.0 linux-x64 node-v18.15.0

USAGE
  $ tfs COMMAND
...

Configuration

TFS CLI provides powerful configuration options to tailor the tool to your needs. Let's delve into the tfs config set commands:

Authentication Token

Authentication tokens are used to authenticate requests to the TFS API. Use the following command to set an authentication token:

tfs config set auth-token <auth-token>

You can obtain an authentication token from the TFS Dashboard.

Encryption Key (Optional)

You can set a global encryption key optionally. This key is utilized for encrypting files during upload and decrypting them during download when no specific key is provided for each command. Execute the command below to set an encryption key:

tfs config set encryption-key <encryption-key>

Usage Examples

To help you make the most of TFS CLI, here are some detailed usage examples for key commands:

Pushing a File

Easily upload a file to the server with the tfs push command. For example, to upload a file with a specified time to live and encryption key:

tfs push /path/to/file --ttl 3600 --key my-secret-key

Pulling a File

Easily download a file from the server with the tfs pull command. For example, to download a file with a specified encryption key:

tfs pull /path/to/file --key my-encryption-key

Documentation

For detailed list of available commands. Your can checkout our documentation on https://trytfs.com/documentation.

Find yourself stuck using the tool? Found a bug? Do you have general questions or suggestions for improvement? Feel free to open an issue on GitHub

Contributing

Please see CONTRIBUTING for details.

Credits

• Olayemi Olatayo
• All Contributors

License

The MIT License (MIT). Please see License File for more information.