Skip to main content

Bundle Management (zeysdk bundle)

The bundle command provides functionality for creating and installing bundles of ZeyOS applications.

Commands

Create Bundle

Creates a bundle file containing selected ZeyOS applications from the current directory.

Usage:

zeysdk bundle create [output] [options]

Parameters

ParameterDescriptionRequiredDefault
outputBundle filenameInteractive prompt

Options

OptionDescriptionDefault
-v, --verboseShow detailed outputfalse

Directory Scanning

  • Scans current directory for potential ZeyOS apps
  • Skips hidden directories (starting with '.')
  • Ignores node_modules and vendor directories
  • Validates each directory for zeyos.app.json
  • Checks for required fields: identifier and name

Interactive Selection

  1. Output File

    • If not provided as argument, prompts for filename
    • Default suggestion: 'bundle'
    • Validates for non-empty input
  2. App Selection

    • Shows checkbox list of valid ZeyOS apps
    • Must select at least one app
    • Maximum 20 items per page
    • Apps sorted alphabetically in output

Install Bundle

Installs multiple applications from a bundle file to a specified instance.

Usage:

zeysdk bundle install <bundle> <instance> [options]

Parameters

ParameterDescriptionRequiredExample
bundlePath to bundle filemy-bundle
instanceTarget instance identifierdev-instance

Options

OptionDescriptionDefault
-v, --verboseShow detailed outputfalse
-f, --forceContinue installation if errors occurfalse

Instance Configuration

If instance not found:

  1. Prompts to configure new instance
  2. Collects instance details:
    • URL (default: https://cloud.zeyos.com/<instance>)
    • Authentication token
  3. Stores credentials securely

Installation Process

  1. Validation

    • Verifies bundle file exists and is readable
    • Checks instance configuration
    • Validates app directories
  2. For Each App

    • Links to specified instance
    • Switches to instance context
    • Pushes app content
    • Shows progress spinner
    • Reports success/failure
  3. Results

    • Shows installation summary
    • Reports successful/failed installations
    • Continues on errors if --force used

Error Handling

Create Bundle Errors

ErrorDescriptionResolution
No directoriesEmpty current folderNavigate to folder with apps
No valid appsNo ZeyOS apps foundVerify app directory structure
Invalid selectionNo apps selectedSelect at least one app
Write errorCannot create bundle fileCheck write permissions

Install Bundle Errors

ErrorDescriptionResolution
Bundle not foundBundle file missingCheck file path
Invalid instanceInstance not configuredFollow setup prompts
Invalid tokenAuthentication failedCheck instance credentials
Directory errorApp directory not foundVerify bundle contents
Push failedApp deployment failedCheck app configuration

Examples

Create a bundle:

zeysdk bundle create my-bundle
zeysdk bundle create --verbose

Install a bundle:

zeysdk bundle install my-bundle dev-instance
zeysdk bundle install my-bundle prod-instance --force --verbose