For reporting bugs, issues, or security vulnerabilities, please visit 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/ account to submit Pull Requests directly.

Install

pnpm add -g @git.zone/tsdeploy

Usage

tsdeploy stores deployment intent locally and produces safe, non-mutating plans. Cloudly or Onebox remains the source of truth for actual deployment instances.

Create or update a local profile in the user config store:

tsdeploy login --profile prod --target cloudly --origin https://cloudly.example.com

Link a project to a Cloudly or Onebox deployment pointer. Use either init for the first pointer write or link to replace the current pointer:

tsdeploy init --profile prod --deploymentId deployment-123
# or
tsdeploy link --profile prod --serviceId service-123

Inspect current local state:

tsdeploy status
tsdeploy doctor
tsdeploy plan

The project pointer is written to .nogit/tsdeploy.json and is intentionally small:

{
  "schemaVersion": 1,
  "profile": "prod",
  "deploymentId": "deployment-123"
}

Profiles are stored in the user smartconfig key-value store. Tokens are never printed by status, doctor, or plan.

Current Scope

This MVP does not install, update, upgrade, or mutate remote deployments. It prepares the local UX and state model for Cloudly/Onebox-backed deployment flows while avoiding duplicate release, Docker, App Store, or remote-authority semantics.

Remote deployment mutations should only be added after the exact Cloudly and Onebox typed APIs for install, update, upgrade, and status are verified upstream.

Programmatic API

import { TsDeploy } from '@git.zone/tsdeploy';

const tsDeploy = new TsDeploy({ projectDir: process.cwd() });

await tsDeploy.saveProfile({
  name: 'prod',
  target: 'cloudly',
  origin: 'https://cloudly.example.com',
});

await tsDeploy.writeProjectLink({
  profile: 'prod',
  deploymentId: 'deployment-123',
});

const plan = await tsDeploy.buildPlan();
console.log(plan.mutationAllowed); // false

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.md 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.

readme.md

@git.zone/tsdeploy

Issue Reporting and Security