gobot-gptscript
v0.5.0-alpha.23
Published
GPTScript helper for Gobot
Downloads
12
Readme
GPTScript via npm
This package allows you to use GPTScript as an npm dependency.
Part of the Gobot project.
Usage
Quick run
npx gobot gptscript --version
Quick use
npm i gobot
import { gobot } from 'gobot'
const bot = await gobot(`gptscript`)
const exitCode = await bot.run([`--version`])
Basic version locking
npm i gobot-gptscript
With gobot-gptscript
present, Gobot will default to the gptscript
version corresponding to the gobot-gptscript
version you installed. Now you can use gptscript
as a real dependency.
import { gobot } from 'gobot'
const bot = await gobot(`gptscript`)
const exitCode = await bot.run([`--version`])
Locking to a specific version
The gobot-gptscript
package version always mirrors the underlying gptscript
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 gptscript
even though gobot-gptscript
is installed.
// Run a specific version (override)
const bot = await gobot(`gptscript`, { version: `0.5.0` })
const exitCode = await bot.run([`--version`])
// Or the latest version (override)
const bot = await gobot(`gptscript`, { version: `*` })
const exitCode = await bot.run([`--version`])
Pass environment variables
import { gobot } from 'gobot'
const bot = await gobot(`gptscript`, {
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(`gptscript`, {
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-gptscript
can be installed globally. It will receive a bin alias:
npm i -g gobot-gptscript
gptscript --help
# Upgrade to @latest or any version
npm i -g gobot-gptscript@latest
CLI
gobot-gptscript
comes with a bin shortcut for CLI usage.
gptscript [options]
GPTScript (https://gptscript.ai/) 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
Sample project
View the GPTScript 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-gptscript
versions mirror gptscript
versions. Gobot knows about 22 releases of gptscript
:
| Version | darwin | linux | win32 | | --------- | --------- | --------- | ----- | | 0.5.0 | arm64/x64 | arm64/x64 | x64 | | 0.4.2 | arm64/x64 | arm64/x64 | x64 | | 0.4.1 | arm64/x64 | arm64/x64 | x64 | | 0.4.0 | arm64/x64 | arm64/x64 | x64 | | 0.3.0 | arm64/x64 | arm64/x64 | x64 | | 0.2.2 | arm64/x64 | arm64/x64 | x64 | | 0.2.1 | arm64/x64 | arm64/x64 | x64 | | 0.2.0 | arm64/x64 | arm64/x64 | x64 | | 0.2.0-rc1 | arm64/x64 | arm64/x64 | x64 | | 0.1.5 | arm64/x64 | arm64/x64 | x64 | | 0.1.4 | arm64/x64 | arm64/x64 | x64 | | 0.1.3 | arm64/x64 | arm64/x64 | x64 | | 0.1.3-rc4 | arm64/x64 | arm64/x64 | x64 | | 0.1.3-rc3 | arm64/x64 | arm64/x64 | x64 | | 0.1.3-rc2 | arm64/x64 | arm64/x64 | x64 | | 0.1.3-rc1 | arm64/x64 | arm64/x64 | x64 | | 0.1.2 | arm64/x64 | arm64/x64 | x64 | | 0.1.1 | arm64/x64 | arm64/x64 | x64 | | 0.1.0 | arm64/x64 | arm64/x64 | x64 | | 0.0.3 | arm64/x64 | arm64/x64 | x64 | | 0.0.2 | arm64/x64 | arm64/x64 | x64 | | 0.0.1 | arm64/x64 | arm64/x64 | x64 |