coolify-cli

command module
v0.0.0-...-9fbb052 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2024 License: MIT Imports: 1 Imported by: 0

README

CLI for Coolify API

Installation

curl -fsSL https://raw.githubusercontent.com/coollabsio/coolify-cli/main/scripts/install.sh | bash

It will install the CLI in /usr/local/bin/coolify and the configuration file in ~/.config/coolify/config.json

If you are a windows or mac user, please test the installation script and let us know if it works for you.

Configuration

  1. Get a <token> from your Coolify dashboard (Cloud or self-hosted) at /security/api-tokens
Cloud
  1. Add the token with coolify instances set token cloud <token>
Self-hosted
  1. Add the token with coolify instances add -d <name> <fqdn> <token>

Replace <name> with the name you want to give to the instance.

Replace <fqdn> with the fully qualified domain name of your Coolify instance.

Now you can use the CLI with the token you just added.

Change default instance

You can change the default instance with coolify instances set default <name>

Currently Supported Commands

Update
  • coolify update - Update the CLI to the latest version
Instances
  • coolify instances list - List all instances
  • coolify instances add - Create a new instance configuration
  • coolify instances remove - Remove an instance configuration
  • coolify instances get - Get an instance configuration
  • coolify instances set <default>|<token> - Set an instance as default or set a token for an instance
  • coolify instances version - Get the version of the Coolify API for an instance
Servers
  • coolify servers list - List all servers
  • coolify servers get - Get a server
    • --resources - Get the resources and their status of a server

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL