{"id":29710624,"url":"https://github.com/letscloud-community/letscloud-cli","last_synced_at":"2025-07-23T21:15:21.754Z","repository":{"id":54149390,"uuid":"321541202","full_name":"letscloud-community/letscloud-cli","owner":"letscloud-community","description":"A command-line interface CLI for LetsCloud","archived":false,"fork":false,"pushed_at":"2025-05-19T21:05:50.000Z","size":36,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-19T21:25:54.394Z","etag":null,"topics":["cli","cloud","go","golang","letscloud"],"latest_commit_sha":null,"homepage":"https://www.letscloud.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/letscloud-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-15T03:24:37.000Z","updated_at":"2025-05-19T21:02:02.000Z","dependencies_parsed_at":"2025-04-30T02:26:15.477Z","dependency_job_id":"711e5a7c-e482-42b3-9688-2bce80411c64","html_url":"https://github.com/letscloud-community/letscloud-cli","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/letscloud-community/letscloud-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letscloud-community%2Fletscloud-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letscloud-community%2Fletscloud-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letscloud-community%2Fletscloud-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letscloud-community%2Fletscloud-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/letscloud-community","download_url":"https://codeload.github.com/letscloud-community/letscloud-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/letscloud-community%2Fletscloud-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266749697,"owners_count":23978448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cloud","go","golang","letscloud"],"created_at":"2025-07-23T21:15:16.089Z","updated_at":"2025-07-23T21:15:21.745Z","avatar_url":"https://github.com/letscloud-community.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# letscloud-cli\n\nThe LetsCloud Command Line is an interface for interacting with LetsCloud Infrastructure.\n\n```\nNAME:\n   letscloud - manage your LetsCloud resources from your terminal\n\nUSAGE:\n   letscloud [command]\n\nVERSION:\n   v1.2.0\n\nCOMMANDS:\n   api-key    Show or Set your API Key\n   locations  Show All Locations\n   plans      Show All Plans by Location\n   images     Show All Images by Location\n   ssh-key    Manage your SSH Keys\n   snapshot   Manage your snapshots\n   instance   Manage your instances\n   profile    Show your Profile Info\n   help, h    Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --help, -h     show help\n   --version, -v  print the version\n\nUse \"letscloud [command] --help\" for more information about a command.\n```\n\n- [Installing `letscloud`](#installing-letscloud)\n   - [Downloading a Release from GitHub](#downloading-a-release-from-github)\n   - [Building the Development Version from Source](#building-the-development-version-from-source)\n   - [Using Docker](#using-docker)\n- [Getting Started](#getting-started)\n- [Examples](#examples)\n   - [Create a New SSH Key](#create-a-new-ssh-key)\n   - [List all instances](#list-all-instances)\n   - [Create new instance](#create-new-instance)\n   - [List all available locations](#list-all-available-locations)\n   - [List all available images by location](#list-all-available-images-by-location)\n   - [List all available plans by location](#list-all-available-plans-by-location)\n\n## Installing `letscloud`\n\nYou can download pre-built binaries for Linux, macOS, and Windows on\nthe [releases page](https://github.com/letscloud-community/letscloud-cli/releases).\n\n### Downloading a Release from GitHub\n\nFind the appropriate archive for your operating system and architecture and download the archive from your browser or copy its URL and retrieve it to your home directory with `wget` or `curl`.\n\nIn this example we used the `version` `1.2.0`, but you have to change for the latest version or what version you want.\n\nExample using `wget`:\n\n```\ncd ~\nwget https://github.com/letscloud-community/letscloud-cli/releases/download/v1.2.0/letscloud-1.2.0-linux-amd64.tar.gz\n```\n\nOr using `curl`\n\n```\ncd ~\ncurl -OL https://github.com/letscloud-community/letscloud-cli/releases/download/v1.2.0/letscloud-1.2.0-linux-amd64.tar.gz\n```\n\nExtract the binary:\n\n```\ntar xf ~/letscloud-1.2.0-linux-amd64.tar.gz\n```\n\nMove the letscloud binary to somewhere in your path. For example, on GNU/Linux and OS X systems:\n\n```\nsudo mv ~/letscloud /usr/local/bin\n```\n\n### Building the Development Version from Source\n\nIf you have a Go environment configured, you can install the development version from the command line.\n\n```\ngo install github.com/letscloud-community/letscloud-cli/cmd/letscloud@latest\n```\n\nAnother way to build from source is clone the repository:\n\n```\ngit clone https://github.com/letscloud-community/letscloud-cli.git\ncd letscloud-cli\nmake build\n```\n\n### Using Docker\n\nYou can also find the image on [Docker Hub](https://hub.docker.com/r/letscloudcommunity/letscloud-cli)\n\nGet the letscloud-cli for Docker\n```\ndocker pull letscloudcommunity/letscloud-cli:latest\n```\n#### Using letscloud-cli with Docker\nWhen using letscloud-cli with Docker, you must pass the environment variable with your API KEY.\n\n\u003e Note: Replace `\u003cYOUR-API-KEY\u003e` with your actual LetsCloud API key.\n\nExample: Running a basic command to return your profile:\n```\ndocker run --rm -it \\\n  --env=LETSCLOUD_API_KEY='\u003cYOUR-API-KEY\u003e' \\\n  letscloudcommunity/letscloud-cli profile\n```\nExample: Running a command to list your instances:\n```\ndocker run --rm -it \\\n  --env=LETSCLOUD_API_KEY='\u003cYOUR-API-KEY\u003e' \\\n  letscloudcommunity/letscloud-cli instance list\n```\n\n## Getting Started\n\n1. Visit the LetsCloud Account at [my.letscloud.io](https://my.letscloud.io),\n\n2. Go to [API tab](https://my.letscloud.io/profile/client-api), and press `Enable API` button.\n\n3. You'll get your API Key. Copy it and save to a safe place.\n\n4. Run the following command to set your API Key for the first time.\n\n   `letscloud api-key set 'your_api_key'`\n   **remember to use single quotes in your api key**  \n   \n   Alternatively, you can export the API Key as an environment variable in linux OS.\n   \n   `export LETSCLOUD_API_KEY='your_api_key'`\n    \n5. That's it. Now you can use the program.\n\n   For example, you can run the `profile` command to see your profile info and your balance.\n   \n   `letscloud profile`\n    \n## Examples\n\n### Create a New SSH Key\nIf you do not provide a `public key`, we will generate a new key and the `private key` will be shown.  \n**Save this key as it is not stored**\n```\nletscloud ssh-key create --title=my-ssh-key\n```\n\n### List all instances\n```\nletscloud instance list\n```\n\n### Create new instance\n```\nletscloud instance create \\\n   --location \u003clocation-slug\u003e \\\n   --plan \u003cplan-slug\u003e \\\n   --image \u003cimage-slug\u003e \\\n   --hostname \u003chost-name\u003e \\\n   --label \u003clabel\u003e \\\n   --password \u003cpassword\u003e\n```\n**The password must:**\n- Be between 12 and 32 characters.\n- Contain at least one uppercase letter.\n- Contain at least one lowercase letter.\n- Contain at least one digit.\n- Contain at least one special character.\n\nExample:\n```\nletscloud instance create \\\n   --location MIA1 \\\n   --plan 1vcpu-1gb-10ssd \\\n   --image ubuntu-24.04-x86_64 \\\n   --hostname test-hostname.com \\\n   --label test-cli \\\n   --password exampleExample@123\n```\n\nExample one-line:\n```\nletscloud instance create --location MIA1 --plan 1vcpu-1gb-10ssd --image ubuntu-24.04-x86_64 --hostname test-hostname.com --label test-cli --password exampleExample@123\n```\n\nor you can create an instance using your SSH key:\n```\nletscloud ssh-key list\n```\n```\nletscloud instance create \\\n   --location MIA1 \\\n   --plan 1vcpu-1gb-10ssd \\\n   --image ubuntu-24.04-x86_64 \\\n   --hostname test-hostname.com \\\n   --label test-cli-key \\\n   --ssh \u003cssh-slug\u003e\n```\n\n### List all available locations\n```\nletscloud locations\n```\n\n### List all available images by location\n```\nletscloud images \u003clocation-slug\u003e\n```\n\n### List all available plans by location\n```\nletscloud plans \u003clocation-slug\u003e\n```\n\n## License\n\nMIT license","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fletscloud-community%2Fletscloud-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fletscloud-community%2Fletscloud-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fletscloud-community%2Fletscloud-cli/lists"}