Web Console, CLI, API


title: How to manage apps in LocalCloud: CLI, Web Console, and API description: How manage app deployments with LocalCloud? date: April 06, 2024


LocalCloud offers three options for managing services, deployments, and machines, catering to different preferences and requirements:

  1. CLI (Command Line Interface):

    The LocalCloud CLI is ideal for Linux or MacOS users. Windows users can SSH into their server and use the CLI there.

    Installing CLI on a Local Machine:

    To install the CLI on your local machine:

    • SSH into a server in your LocalCloud project or a local machine connected to the LocalCloud VPN.
    • Start the LocalCloud CLI by running:

      jsx localcloud

    • Navigate to “Servers/Local Machines” → “Add local machine.”

    • Enter a name for your local machine.
    • Copy the displayed installation command from the terminal.
    • On your local machine, open Terminal and execute the copied command (administrator rights required).
    • Web Console:

    The LocalCloud Web Console provides a graphical user interface (GUI) for managing your LocalCloud projects. It's designed to be secure and private:

    • The console does not store any project-related data.
    • It displays data only when you are connected to your project’s VPN.
    • Currently in private beta, the Web Console is set to be publicly available by the end of January.
    • API:

    The LocalCloud API offers the same functionalities as the CLI, enabling programmatic control and automation:

    • Ideal for integrating LocalCloud operations into scripts or custom development workflows.
    • For usage examples and more details, check out the CLI Git Repository.

Each of these options is designed to provide efficient and user-friendly ways to manage your LocalCloud environment. Whether you prefer the directness of the CLI, the visual approach of the Web Console, or the versatility of the API, LocalCloud is designed for a seamless and secure management experience.