Swarms Cloud CLI Documentation¶
Welcome to the Swarms Cloud CLI documentation. This guide will help you understand how to use the CLI to interact with the Swarms Cloud platform.
Table of Contents¶
- Introduction
- Installation
- Usage
- Commands
- onboarding
- help
- get-api-key
- check-login
- read-docs
- Troubleshooting
- FAQs
- Contact Support
Introduction¶
The Swarms Cloud CLI is a command-line interface tool that allows you to interact with the Swarms Cloud platform. It provides various commands to help you manage your account, retrieve API keys, and access documentation.
Installation¶
To install the Swarms Cloud CLI, you need to have Python installed on your system. You can then install the CLI using pip:
Usage¶
Once installed, you can use the CLI by typing swarms-cloud
followed by the command you wish to execute. For example:
Commands¶
onboarding¶
Starts the onboarding process to help you set up your account.
help¶
Displays the help message with a list of available commands.
get-api-key¶
Opens the API key retrieval page in your default web browser.
check-login¶
Checks if you are logged in and starts the cache if necessary.
read-docs¶
Redirects you to the Swarms Cloud documentation page.
Troubleshooting¶
If you encounter any issues while using the CLI, ensure that you have the latest version installed. You can update the CLI using:
FAQs¶
Q: How do I retrieve my API key?
A: Use the get-api-key
command to open the API key retrieval page.
Q: What should I do if I am not logged in?
A: Use the check-login
command to log in and start the cache.
Contact Support¶
If you need further assistance, please contact our support team at kye@swarms.world