surrealdb/SurrealKit

Install SurrealKit and run migrations, tests, sync, seed, or any subcommand in CI.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
versionSurrealKit version to install (e.g. "v0.5.3"). Use "latest" to resolve the most recent release.nolatest
commandSurrealKit subcommand to run after install. Set to an empty string to install only.notest
argsAdditional arguments appended to the subcommand.no""
working-directoryDirectory containing your SurrealKit project (the folder with "database/").no.
hostSurrealDB host, mapped to SURREALDB_HOST.no""
nsSurrealDB namespace, mapped to SURREALDB_NAMESPACE.no""
dbSurrealDB database, mapped to SURREALDB_NAME.no""
userSurrealDB username, mapped to SURREALDB_USER.no""
passSurrealDB password, mapped to SURREALDB_PASSWORD.no""
github-tokenToken used to query the GitHub releases API when resolving "latest".no${{ github.token }}
namedescription
versionThe resolved SurrealKit version that was installed.
pathAbsolute path to the installed SurrealKit binary directory.