jkunz
f40ef6b7c0
Align Cloudly with the current typedserver, smartconfig, smartstate, and Docker tooling releases so builds and Docker output stay compatible with the upgraded stack.
106 lines
4.7 KiB
Markdown
106 lines
4.7 KiB
Markdown
# @serve.zone/cli
|
|
|
|
`@serve.zone/cli` is the published Cloudly CLI submodule. It provides the `servezone` binary and currently acts as a thin environment-driven client for connecting to a Cloudly control plane and listing clusters through `@serve.zone/api`.
|
|
|
|
## Issue Reporting and Security
|
|
|
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
|
|
## Current Scope
|
|
|
|
This submodule is intentionally small in the current codebase:
|
|
|
|
- Reads `CLOUDLY_URL` through `@push.rocks/qenv`.
|
|
- Authenticates with either `CLOUDLY_TOKEN` or `CLOUDLY_USERNAME` plus `CLOUDLY_PASSWORD`.
|
|
- Starts a `CloudlyApiClient` registered as `cli`.
|
|
- Creates a `CliClient` wrapper around the API client.
|
|
- Calls `CliClient.getClusters()` and prints the result.
|
|
|
|
It is not currently a full command tree for services, secrets, deployments, logs, profiles, or shell completion. Those flows should be implemented against `@serve.zone/api` before documenting them as CLI commands.
|
|
|
|
## Installation
|
|
|
|
The package is published from `cloudly/ts_cliclient` via `tspublish.json` under the name `@serve.zone/cli` with the `servezone` binary.
|
|
|
|
```sh
|
|
pnpm add --global @serve.zone/cli
|
|
```
|
|
|
|
For local development inside the Cloudly repository, build the parent package:
|
|
|
|
```sh
|
|
pnpm install
|
|
pnpm build
|
|
```
|
|
|
|
## Usage
|
|
|
|
Authenticate with a machine token:
|
|
|
|
```sh
|
|
CLOUDLY_URL=https://cloudly.example.com \
|
|
CLOUDLY_TOKEN=cluster-or-api-token \
|
|
servezone
|
|
```
|
|
|
|
Authenticate with username and password:
|
|
|
|
```sh
|
|
CLOUDLY_URL=https://cloudly.example.com \
|
|
CLOUDLY_USERNAME=admin \
|
|
CLOUDLY_PASSWORD=change-me \
|
|
servezone
|
|
```
|
|
|
|
When `CLOUDLY_TOKEN` is present, the CLI requests a stateful identity and asks Cloudly to tag the WebSocket connection. When username/password are present instead, it uses Cloudly's admin login flow. If no credentials are provided, the CLI prints a warning before attempting the default cluster-list operation.
|
|
|
|
## Programmatic Use
|
|
|
|
The published submodule exports the `runCli()` entry point. For automation, most callers should use `@serve.zone/api` directly; the internal `CliClient` currently wraps `CloudlyApiClient` only to run the default cluster-list action:
|
|
|
|
```ts
|
|
import { CloudlyApiClient } from '@serve.zone/api';
|
|
import { CliClient } from './classes.cliclient.js';
|
|
|
|
const apiClient = new CloudlyApiClient({
|
|
registerAs: 'cli',
|
|
cloudlyUrl: 'https://cloudly.example.com',
|
|
});
|
|
|
|
await apiClient.start();
|
|
await apiClient.loginWithUsernameAndPassword('admin', 'change-me');
|
|
|
|
const cli = new CliClient(apiClient);
|
|
await cli.getClusters();
|
|
```
|
|
|
|
## Files
|
|
|
|
| Path | Purpose |
|
|
| --- | --- |
|
|
| `index.ts` | Runtime entry point for the published CLI. |
|
|
| `classes.cliclient.ts` | Minimal client wrapper; currently exposes `getClusters()`. |
|
|
| `plugins.ts` | Centralized imports for the submodule. |
|
|
| `tspublish.json` | Published package name, dependencies, registry targets, and `servezone` bin metadata. |
|
|
|
|
## License and Legal Information
|
|
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](../license) file.
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
### Company Information
|
|
|
|
Task Venture Capital GmbH
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|