Back to Details

guara-cloud

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

GuaraCloud Platform

GuaraCloud平台

GuaraCloud is a Platform-as-a-Service that deploys containerized applications from GitHub repositories. Billing is in BRL (Brazilian Real).
GuaraCloud是一款从GitHub仓库部署容器化应用的平台即服务（Platform-as-a-Service，PaaS）。计费货币为巴西雷亚尔（BRL）。

Core Concepts

核心概念

User — Authenticated via GitHub or Google OAuth. Has one subscription tier (hobby, pro, business, enterprise) that governs limits across all projects.
Project — Organizational unit containing one or more services. Each project is isolated.
Service — A deployable container within a project. Has its own subdomain, env vars, scaling config, and deployment history. Subdomain format: 
{service}-{project}.guaracloud.com
.
Deployment — A build-and-deploy cycle triggered by git push, manual trigger, rollback, or config change. Tracks build status, image tag, commit SHA, and errors.
Domain — Each service gets an automatic subdomain. Users can add custom domains via CNAME verification.
Project Members — Role-based access: 
owner
, 
admin
, 
member
, 
viewer
.
用户 — 通过GitHub或Google OAuth进行身份验证。拥有一个订阅套餐层级（hobby、pro、business、enterprise），该层级管控所有项目的使用限制。
项目 — 包含一个或多个服务的组织单元。每个项目相互隔离。
服务 — 项目内可部署的容器。拥有独立的子域名、环境变量、扩缩容配置以及部署历史。子域名格式：
{service}-{project}.guaracloud.com
。
部署 — 由git推送、手动触发、回滚或配置变更触发的构建与部署周期。追踪构建状态、镜像标签、提交SHA以及错误信息。
域名 — 每个服务会自动获得一个子域名。用户可通过CNAME验证添加自定义域名。
项目成员 — 基于角色的访问权限：
owner
（所有者）、
admin
（管理员）、
member
（成员）、
viewer
（查看者）。

CLI Installation

CLI安装

bash
npm install -g @guaracloud/cli
Binary names: 
guara
or 
guaracloud
(interchangeable).
Requires Node.js >= 20.
bash
npm install -g @guaracloud/cli
二进制名称：
guara
或 
guaracloud
（可互换使用）。
要求Node.js版本 >= 20。

Authentication

身份认证

bash
undefined
bash
undefined

Browser-based OAuth (interactive)

基于浏览器的OAuth（交互式）

guara login
guara login

Direct API key (non-interactive / CI)

直接使用API密钥（非交互式/CI场景）

guara login --api-key <key>
guara login --api-key <key>

Verify

验证身份

guara whoami

API keys are stored in the OS keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service). Falls back to config file if keychain unavailable.

**Environment variable override:** Set `GUARA_API_KEY` to skip stored credentials.
guara whoami

API密钥存储在操作系统密钥链中（macOS Keychain、Windows凭据管理器、Linux Secret Service）。若密钥链不可用，则回退到配置文件存储。

**环境变量覆盖：** 设置`GUARA_API_KEY`可跳过存储的凭据。

Context Resolution

上下文解析

Commands that need a project/service resolve context in this order:
  1. --project
    / 
    --service
    flags
  2. GUARA_PROJECT
    / 
    GUARA_SERVICE
    environment variables
  3. .guara.json
    file (walked upward from current directory)
Link a directory to a project:
bash
guara link
需要项目/服务的命令按以下顺序解析上下文：
  1. --project
    / 
    --service
    标志
  2. GUARA_PROJECT
    / 
    GUARA_SERVICE
    环境变量
  3. .guara.json
    文件（从当前目录向上遍历查找）
将目录与项目关联：
bash
guara link

Creates .guara.json with { "project": "slug", "service": "slug" }

创建包含 { "project": "slug", "service": "slug" } 的 .guara.json 文件

undefined
undefined

Global Flags

全局标志

FlagShortDescription
--json
Output as JSON
--quiet
-q
Suppress non-essential output
--project
-p
Project slug override
--service
-s
Service slug override
--yes
-y
Skip confirmation prompts
--api-key
Override API key for this request
--api-url
Override API base URL
标志简写描述
--json
以JSON格式输出
--quiet
-q
抑制非必要输出
--project
-p
覆盖项目slug
--service
-s
覆盖服务slug
--yes
-y
跳过确认提示
--api-key
覆盖本次请求的API密钥
--api-url
覆盖API基础URL

Command Index

命令索引

CommandPurposeSee skill
login
Authenticate—
logout
Clear credentials—
whoami
Show current user—
projects list
List projectsguara-deploy
projects create
Create projectguara-deploy
projects info
Project detailsguara-deploy
services list
List servicesguara-deploy
services create
Create serviceguara-deploy
services info
Service detailsguara-deploy
services start
Start stopped serviceguara-deploy
services stop
Stop running serviceguara-deploy
services restart
Rolling restartguara-deploy
services delete
Delete serviceguara-deploy
deploy
Trigger deploymentguara-deploy
rollback
Rollback deploymentguara-deploy
deployments list
Deployment historyguara-deploy
scale
Toggle autoscalingguara-deploy
domains list
List custom domainsguara-deploy
domains add
Add custom domainguara-deploy
domains remove
Remove domainguara-deploy
env list
List env varsguara-develop
env set
Set env varsguara-develop
env unset
Remove env varsguara-develop
link
Link dir to projectguara-develop
unlink
Remove linkguara-develop
exec
Shell into containerguara-develop
proxy
Forward local portguara-develop
logs
View/stream logsguara-develop
open
Open service in browser—
status
Platform status—
config list
Show CLI config—
config get
Get config value—
config set
Set config value—
config reset
Reset to defaults—
For full flag reference, see references/commands.md.
命令用途参考技能
login
身份认证—
logout
清除凭据—
whoami
显示当前用户—
projects list
列出项目guara-deploy
projects create
创建项目guara-deploy
projects info
项目详情guara-deploy
services list
列出服务guara-deploy
services create
创建服务guara-deploy
services info
服务详情guara-deploy
services start
启动已停止的服务guara-deploy
services stop
停止运行中的服务guara-deploy
services restart
滚动重启guara-deploy
services delete
删除服务guara-deploy
deploy
触发部署guara-deploy
rollback
回滚部署guara-deploy
deployments list
部署历史guara-deploy
scale
切换自动扩缩容guara-deploy
domains list
列出自定义域名guara-deploy
domains add
添加自定义域名guara-deploy
domains remove
删除域名guara-deploy
env list
列出环境变量guara-develop
env set
设置环境变量guara-develop
env unset
删除环境变量guara-develop
link
将目录与项目关联guara-develop
unlink
解除关联guara-develop
exec
进入容器Shellguara-develop
proxy
转发本地端口guara-develop
logs
查看/流式传输日志guara-develop
open
在浏览器中打开服务—
status
平台状态—
config list
显示CLI配置—
config get
获取配置值—
config set
设置配置值—
config reset
重置为默认值—
如需完整的标志参考，请查看references/commands.md。

Tier Information

套餐层级信息

For tier limits, pricing, and quotas, see guaracloud.com/docs. The CLI will return descriptive errors when a tier limit is reached.
关于套餐层级限制、定价和配额，请查看guaracloud.com/docs。当达到套餐层级限制时，CLI会返回描述性错误信息。

Important Rules

重要规则

  • Always use the 
    guara
    CLI.     Do not call the REST API directly.
  • Check service status before suggesting actions. Run 
    guara services info
    to see current state.
  • Use 
    --json
    for scripting.     Parse structured output instead of scraping human-readable text.
  • Link projects with 
    guara link
    so context resolution works automatically.
  • 始终使用
    guara
    CLI    。不要直接调用REST API。
  • 在建议操作前检查服务状态。运行
    guara services info
    查看当前状态。
  • 脚本场景使用
    --json
    。解析结构化输出，而非抓取人类可读文本。
  • 使用
    guara link
    关联项目    ，以便自动完成上下文解析。