Constellation via npm

This package allows you to use Constellation as an npm dependency.

Part of the Gobot project.

Usage

Quick run

npx gobot constellation --version

Quick use

npm i gobot

import { gobot } from 'gobot'
const bot = await gobot(`constellation`)
const exitCode = await bot.run([`--version`])

Basic version locking

npm i gobot-constellation

With gobot-constellation present, Gobot will default to the constellation version corresponding to the gobot-constellation version you installed. Now you can use constellation as a real dependency.

import { gobot } from 'gobot'
const bot = await gobot(`constellation`)
const exitCode = await bot.run([`--version`])

Locking to a specific version

The gobot-constellation package version always mirrors the underlying constellation version:

npm i [email protected]

Override the default version imposed by this package

In rare cases, you may want to intentionally run a different version of constellation even though gobot-constellation is installed.

// Run a specific version (override)
const bot = await gobot(`constellation`, { version: `2.16.3` })
const exitCode = await bot.run([`--version`])

// Or the latest version (override)
const bot = await gobot(`constellation`, { version: `*` })
const exitCode = await bot.run([`--version`])

Pass environment variables

import { gobot } from 'gobot'
const bot = await gobot(`constellation`, {
  env: process.env, // This is not always necessary, but some apps do need it
})
const exitCode = await bot.run([`--version`])

Access the child process

import { gobot } from 'gobot'
const bot = await gobot(`constellation`, {
  env: process.env,
})
const exitCode = await bot.run(
  [`--help`],
  { cwd: `./foo` }, // SpawnOptions
  (proc) => {
    // ChildProcess
    proc.stdout.on('exit', (code) => {
      console.log(`process has exited`)
    })
  },
)

Install globally for CLI access

Exactly one gobot-constellation can be installed globally. It will receive a bin alias:

npm i -g gobot-constellation
constellation --help

# Upgrade to  @latest or any version
npm i -g gobot-constellation@latest

CLI

gobot-constellation comes with a bin shortcut for CLI usage.

constellation [options]

Constellation (https://github.com/edgelesssys/constellation) runner for Gobot (https://github.com/benallfree/gobot)

Options

| Name | Default | Discussion | | ----------------- | --------------- | --------------------------------------------------------------------------- | | --g-v | true | Show informational output | | --g-vv | false | Show even more output | | --g-vvv | false | Show even more output | | --g-cache-path | host specific | The cache path to use | | --g-use-version | * | Run a specific binary version (format: x.y.z semver or x.y.* semver range) | | --g-os | host specific | Specify OS/Platform | | --g-arch | host specific | Specify OS/Platform |

API

Full API docs

Sample project

View the Constellation sample project on github.

Try Gobot's other apps

Gobot has a growing list (currently 53) of official apps. Have you tried them all?

Getting Help

Join our Discord community.

Why?

If you are writing a nodejs application that depends upon binaries being present (like PocketHost does), you can add this package as a dependency and execute the binary via CLI or programmatically. This package will make sure your desired external binaries are always available.

If you just want to grab a binary quickly for your own use, npx gobot@latest <app> is quite a bit easier than manually downloading zips and installing binaries in shell paths. Gobot handles it all for you effortlessly.

Adding your app to the Gobot registry

We want to add native support for lots of binary apps!

If you use publish statically linked binary releases on github, you are already 98% compatible with Gobot. In fact, Gobot may already know how to work with it.

To see what initial support looks like:

npx gobot inspect <user>/<repo>

This will index all the releases from your repo and show you exactly what Gobot sees.

If you see everything you expect, you're golden. If things are missing, it may mean some custom programming. Either way, jump on Discord and let us know your results.

If you have the flexibility or are starting a new project, make sure your release names follows these rules:

• Ends in .zip, .tgz, .tar.gz, .bz2
• Include the version (semver recommended)
• Include the platform (freebsd, darwin, linux, win32)
• Include the architecture (arm64, x64, ia32, arm)

Note: GoReleaser is a great option if you're publish a Go-based project.

Contributing

We could use help testing and making sure this works across lots of platforms.

To test a build locally:

pnpm test

All known releases

gobot-constellation versions mirror constellation versions. Gobot knows about 32 releases of constellation:

| Version | darwin | linux | win32 | | ------- | --------- | --------- | ----- | | 2.16.3 | arm64/x64 | arm64/x64 | x64 | | 2.16.2 | arm64/x64 | arm64/x64 | x64 | | 2.16.1 | arm64/x64 | arm64/x64 | x64 | | 2.16.0 | arm64/x64 | arm64/x64 | x64 | | 2.15.1 | arm64/x64 | arm64/x64 | x64 | | 2.15.0 | arm64/x64 | arm64/x64 | x64 | | 2.14.3 | arm64/x64 | arm64/x64 | x64 | | 2.14.2 | arm64/x64 | arm64/x64 | x64 | | 2.14.1 | arm64/x64 | arm64/x64 | x64 | | 2.14.0 | arm64/x64 | arm64/x64 | x64 | | 2.13.0 | arm64/x64 | arm64/x64 | x64 | | 2.12.0 | arm64/x64 | arm64/x64 | x64 | | 2.11.0 | arm64/x64 | arm64/x64 | x64 | | 2.10.1 | arm64/x64 | arm64/x64 | x64 | | 2.10.0 | arm64/x64 | arm64/x64 | x64 | | 2.9.1 | arm64/x64 | arm64/x64 | x64 | | 2.9.0 | arm64/x64 | arm64/x64 | x64 | | 2.8.0 | arm64/x64 | arm64/x64 | | | 2.7.1 | arm64/x64 | arm64/x64 | | | 2.7.0 | arm64/x64 | arm64/x64 | | | 2.6.0 | arm64/x64 | arm64/x64 | | | 2.5.3 | arm64/x64 | arm64/x64 | | | 2.5.2 | arm64/x64 | arm64/x64 | | | 2.5.1 | arm64/x64 | arm64/x64 | | | 2.5.0 | arm64/x64 | arm64/x64 | | | 2.4.0 | arm64/x64 | arm64/x64 | | | 2.3.0 | arm64/x64 | arm64/x64 | | | 2.2.2 | arm64/x64 | arm64/x64 | | | 2.2.1 | arm64/x64 | arm64/x64 | | | 2.2.0 | arm64/x64 | arm64/x64 | | | 2.1.0 | arm64/x64 | arm64/x64 | | | 2.0.0 | arm64/x64 | arm64/x64 | |