@ship.zone/szci

Documentation for @ship.zone/szci

readme.md for @ship.zone/szci

A lightweight CI/CD orchestrator built with Deno that unifies Node.js, Docker, NPM, SSH, and Git workflows into a single CLI. Compiles to standalone binaries β€” no runtime required.

Issue Reporting and Security

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.

πŸ—οΈ Architecture

szci is a thin orchestrator β€” it doesn't reinvent the wheel. Instead, it wires up best-in-class tools and handles the CI-specific glue:

Domain What szci does Delegates to
🐳 Docker Bridges SZCI_LOGIN_DOCKER* env vars, auto-detects GitLab CI tokens @git.zone/tsdocker
πŸ“¦ NPM Generates .npmrc from SZCI_TOKEN_NPM* env vars, handles multi-registry publish pnpm + npm publish
🟒 Node.js Manages Node versions via NVM with named aliases nvm
πŸ”‘ SSH Deploys SSH keys from env vars to ~/.ssh @push.rocks/smartssh
πŸ”€ Git Mirrors repos to GitHub git remote 
CLI Input (Deno.args)
    ↓
SmartCLI Router
    ↓
β”œβ”€ szci docker *   β†’ env var bridging β†’ npx @git.zone/tsdocker
β”œβ”€ szci npm *      β†’ .npmrc generation β†’ pnpm / npm publish
β”œβ”€ szci node *     β†’ version aliasing  β†’ nvm install
β”œβ”€ szci git *      β†’ token injection   β†’ git push --mirror
└─ szci ssh *      β†’ key parsing       β†’ write to ~/.ssh

πŸ“₯ Installation

Automated Installer (Recommended)

The easiest way to install szci is using the automated installer script. It handles platform detection, binary download, and global setup:

curl -sSL https://code.foss.global/ship.zone/szci/raw/branch/main/install.sh | sudo bash

To install a specific version:

curl -sSL https://code.foss.global/ship.zone/szci/raw/branch/main/install.sh | sudo bash -s -- --version v7.0.0

Via NPM (downloads pre-compiled binary)

npm install -g @ship.zone/szci

From Source

git clone https://code.foss.global/ship.zone/szci.git
cd szci
deno task compile

The compiled binaries land in dist/binaries/ for Linux (x64/arm64), macOS (x64/arm64), and Windows (x64).

πŸš€ Quick Start

# Setup Node.js environment
szci node install stable

# Install project dependencies
szci npm install

# Build & push Docker images
szci docker build
szci docker push registry.example.com

# Run tests
szci npm test

πŸ“– CLI Reference

szci docker β€” Docker Operations

All Docker commands delegate to @git.zone/tsdocker after bridging environment variables.

szci docker build                        # Build all Dockerfiles in cwd
szci docker login                        # Login to all configured registries
szci docker prepare                      # Alias for login
szci docker push registry.example.com    # Push images to a registry
szci docker pull registry.example.com    # Pull images from a registry
szci docker test                         # Test Dockerfiles

Env var bridging: Before delegating, szci converts its own env var format to tsdocker's expected format:

SZCI_LOGIN_DOCKER_1  β†’  DOCKER_REGISTRY_1
SZCI_LOGIN_DOCKER_2  β†’  DOCKER_REGISTRY_2
...

In GitLab CI, CI_JOB_TOKEN is automatically bridged as DOCKER_REGISTRY_0 for registry.gitlab.com.

szci npm β€” NPM/pnpm Workflows

szci npm install     # Runs pnpm install
szci npm build       # Runs pnpm run build
szci npm test        # Runs pnpm test
szci npm prepare     # Generates ~/.npmrc from SZCI_TOKEN_NPM* env vars
szci npm publish     # Full workflow: prepare β†’ install β†’ build β†’ clean β†’ npm publish

The publish command supports multi-registry publishing. If npmAccessLevel is public and a Verdaccio registry is configured, it publishes to both npm and Verdaccio automatically.

szci node β€” Node.js Version Management

szci node install stable    # Node.js 22
szci node install lts       # Node.js 20
szci node install legacy    # Node.js 18
szci node install 21        # Any specific version

Uses NVM under the hood (auto-detected at /usr/local/nvm/nvm.sh or ~/.nvm/nvm.sh). After installing, it:

  1. Sets the installed version as nvm alias default
  2. Upgrades npm to latest
  3. Installs any global tools listed in npmextra.json β†’ npmGlobalTools

szci ssh β€” SSH Key Deployment

szci ssh prepare    # Deploy SSH keys from env vars to ~/.ssh

Reads all SZCI_SSHKEY_* env vars and writes the keys to disk.

szci git β€” Git Mirroring

szci git mirror    # Mirror repository to GitHub

Pushes all branches and tags to a GitHub mirror. Requires SZCI_GIT_GITHUBTOKEN. Refuses to mirror packages marked as private in package.json.

βš™οΈ Configuration

npmextra.json

Place this in your project root to configure szci behavior:

{
  "@ship.zone/szci": {
    "npmGlobalTools": ["typescript", "pnpm"],
    "npmAccessLevel": "public",
    "npmRegistryUrl": "registry.npmjs.org",
    "urlCloudly": "https://cloudly.example.com"
  }
}
Option Type Default Description
npmGlobalTools string[] [] Global npm packages to install during node install
npmAccessLevel "public" | "private" "private" Access level for npm publish
npmRegistryUrl string "registry.npmjs.org" Default npm registry
urlCloudly string? β€” Cloudly endpoint URL (can also be set via SZCI_URL_CLOUDLY)

πŸ” Environment Variables

Docker Registry Authentication

Pipe-delimited format: registry|username|password

SZCI_LOGIN_DOCKER_1="registry.example.com|myuser|mypass"
SZCI_LOGIN_DOCKER_2="ghcr.io|token|ghp_xxxx"

In GitLab CI, the CI_JOB_TOKEN is automatically used for registry.gitlab.com β€” no manual config needed.

NPM Registry Authentication

Pipe-delimited format: registry|token[|plain]

# Base64-encoded token (default)
SZCI_TOKEN_NPM_1="registry.npmjs.org|dGhlLXRva2VuLWhlcmU="

# Plain text token
SZCI_TOKEN_NPM_2="verdaccio.example.com|the-token-here|plain"

SSH Keys

Pipe-delimited format: host|privKeyBase64|pubKeyBase64

SZCI_SSHKEY_1="github.com|BASE64_PRIVATE_KEY|BASE64_PUBLIC_KEY"
SZCI_SSHKEY_2="gitlab.com|BASE64_PRIVATE_KEY|##"   # Use ## to skip a field

Git Mirroring

SZCI_GIT_GITHUBTOKEN="ghp_your_personal_access_token"
SZCI_GIT_GITHUBGROUP="your-org"       # Defaults to repo owner
SZCI_GIT_GITHUB="your-repo"           # Defaults to repo name

Debugging & Testing

DEBUG_SZCI="true"      # Log all shell commands before execution
SZCI_TEST="true"       # Test mode: mocks bash execution, skips SSH disk writes

Full Environment Variable Reference

Variable Purpose
SZCI_LOGIN_DOCKER_* Docker registry credentials (pipe-delimited)
SZCI_TOKEN_NPM_* NPM registry auth tokens (pipe-delimited)
SZCI_SSHKEY_* SSH key pairs (pipe-delimited)
SZCI_GIT_GITHUBTOKEN GitHub personal access token for mirroring
SZCI_GIT_GITHUBGROUP GitHub org/user for mirror target
SZCI_GIT_GITHUB GitHub repo name for mirror target
SZCI_URL_CLOUDLY Cloudly endpoint URL
SZCI_COMPUTED_REPOURL Override auto-detected repo URL
DEBUG_SZCI Enable verbose shell command logging
SZCI_TEST Enable test mode (mock execution)

πŸ”„ CI/CD Integration Examples

GitLab CI

image: node:22

stages:
  - prepare
  - build
  - test
  - deploy

before_script:
  - curl -sSL https://code.foss.global/ship.zone/szci/raw/branch/main/install.sh | bash

prepare:
  stage: prepare
  script:
    - szci node install stable
    - szci npm install

build:
  stage: build
  script:
    - szci docker build

test:
  stage: test
  script:
    - szci npm test

deploy:
  stage: deploy
  script:
    - szci docker push $CI_REGISTRY
  only:
    - master

πŸ’‘ In GitLab CI, CI_JOB_TOKEN is automatically detected β€” szci will login to registry.gitlab.com without any extra config.

GitHub Actions

name: CI/CD

on:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install szci
        run: curl -sSL https://code.foss.global/ship.zone/szci/raw/branch/main/install.sh | sudo bash

      - name: Setup Node.js
        run: szci node install stable

      - name: Install & Build
        run: |
          szci npm install
          szci npm build

      - name: Test
        run: szci npm test

      - name: Push Docker
        if: github.ref == 'refs/heads/main'
        run: szci docker push ghcr.io
        env:
          SZCI_LOGIN_DOCKER_1: "ghcr.io|${{ github.actor }}|${{ secrets.GITHUB_TOKEN }}"

Gitea CI (Woodpecker)

steps:
  - name: ci
    image: node:22
    commands:
      - curl -sSL https://code.foss.global/ship.zone/szci/raw/branch/main/install.sh | bash
      - szci node install stable
      - szci npm install
      - szci docker build
      - szci npm test

πŸ”„ Migration from npmci

Upgrading from @ship.zone/npmci? Three steps:

  1. Rename the binary β€” replace npmci with szci in all CI scripts
  2. Rename env vars β€” NPMCI_* β†’ SZCI_* (same formats, just the prefix changed)
  3. Docker ops β€” now delegate to @git.zone/tsdocker (installed automatically via npx)
Old New
NPMCI_LOGIN_DOCKER* SZCI_LOGIN_DOCKER*
NPMCI_TOKEN_NPM* SZCI_TOKEN_NPM*
NPMCI_SSHKEY_* SZCI_SSHKEY_*
NPMCI_GIT_GITHUBTOKEN SZCI_GIT_GITHUBTOKEN
NPMCI_URL_CLOUDLY SZCI_URL_CLOUDLY
DEBUG_NPMCI DEBUG_SZCI
NPMTS_TEST SZCI_TEST

πŸ› οΈ Development

# Type check
deno task check

# Run tests
deno task test

# Watch tests
deno task test:watch

# Dev mode
deno task dev -- --help

# Compile binaries for all platforms
deno task compile

# Format code
deno task fmt

# Lint
deno task lint

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the 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

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.

changelog.md for @ship.zone/szci

2026-02-08 - 7.1.2 - fix(readme)

2026-02-07 - 7.1.1 - fix(workflows)

normalize default branch to 'main' across CI/release workflows and docs; update package metadata; clean .gitignore and fix readme license link

2026-02-07 - 7.1.0 - feat(installer)

switch installer/docs to use main branch; add automated installer instructions and update CI examples to use the installer; add release registries and access level in npmextra.json

2026-02-06 - 7.0.0 - BREAKING CHANGE(szci)

delegate Docker operations to @git.zone/tsdocker, remove internal Docker managers and deprecated modules, simplify CLI and env var handling

2025-10-26 - 6.0.1 - fix(tests)

Migrate tests to Deno native runner and update Deno config

2025-10-26 - 6.0.0 - BREAKING CHANGE(szci)

Rename project from npmci to szci and migrate runtime to Deno; add compiled binaries, installer and wrapper; update imports, env handling and package metadata

2024-11-17 - 4.1.37 - fix(docker)

Enhanced base image extraction logic from Dockerfile

2024-11-17 - 4.1.36 - fix(docker)

Improve logging for Dockerfile build order with base image details.

2024-11-17 - 4.1.35 - fix(docker)

Fix Dockerfile dependency sorting and enhance environment variable handling for GitHub repos

2024-11-05 - 4.1.34 - fix(connector)

Remove unused typedrequest implementation in cloudlyconnector

2024-11-05 - 4.1.33 - fix(core)

Updated dependencies and improved npm preparation logic.

2024-10-23 - 4.1.32 - fix(dependencies)

Update project dependencies to latest versions

2022-10-24 - 4.0.11 - prerelease

now includes a precheck for more generic runner execution

2022-10-09 to 2022-10-11 - 4.0.0 to 4.0.10 - migration

internal migrations and fixes

2019-11-26 - 3.1.73 - fixes

correctly setting npm cache and other updates

2018-12-23 - 3.1.19 - privacy updates

enhanced mirroring controls for private code

2018-11-24 - 3.1.2 - ci improvement

removed unnecessary build dependency

2018-09-22 - 3.0.59 - enhancement

integrated smartlog for improved logging

2017-09-08 - 3.0.14 - analytics

added analytics features

2017-08-29 - 3.0.9 - docker enhancements

docker improvements and build args implementation

2017-07-27 - 2.4.0 - stability improvements

various updates to stabilize the environment

2016-11-25 - 2.3.24 - global tools

improved handling for global tool installations