Installing endpointsctl

endpointsctl is an open-source command-line interface (CLI). You can use endpointsctl to work with endpoints and Endpoints AI projects.

When you create a endpoint, it comes with endpointsctl installed and configured with a point-scoped API key. You can also run runpodctl locally.

To install endpointsctl on your local machine, run the appropriate command for your operating system.

wget -qO- cli.runpod.net | sudo bash

Before utilizing endpointsctl, it's essential to configure an API key. To generate a new API key, follow these steps:

Navigate to your Settings in the web interface.

Expand the API Keys section and click on the + API Key button.

Choose either Read or Read & Write permissions.

Click on Create to generate the API key.

NOTE: Protect the secrecy of your API key. Possession of the key grants full access to your account, so it should be kept confidential at all times.

Now that you have generated an API key, execute the following command to integrate it with endpointsctl:

endpointsctl config --apiKey your-api-k

You should see something similar to the following output:

saved apiKey into config file: /Users/endpoints/.endpoints/config.toml

After configuring an API key, ensure that endpointsctl has been installed successfully. Execute the following command:

endpointsctl version

You should see which version is installed.

endpointsctl v1.13.0

If you require assistance with a command at any stage, you can utilize the --help flag to access documentation for the specific command you are executing.

endpointsctl --help