https://github.com/elide-dev/setup-elide
Sets up Elide in a GitHub action
https://github.com/elide-dev/setup-elide
elide github-actions runtime
Last synced: about 1 month ago
JSON representation
Sets up Elide in a GitHub action
- Host: GitHub
- URL: https://github.com/elide-dev/setup-elide
- Owner: elide-dev
- License: mit
- Created: 2023-10-15T23:46:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T05:19:01.000Z (2 months ago)
- Last Synced: 2025-04-01T17:53:38.929Z (2 months ago)
- Topics: elide, github-actions, runtime
- Language: TypeScript
- Homepage: https://elide.dev
- Size: 1.87 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# GitHub Action: Setup Elide
[](https://elide.dev)
[](https://github.com/elide-dev/setup-elide/actions)
[](https://codecov.io/gh/elide-dev/setup-elide)
[](.github/CODE_OF_CONDUCT.md)
This repository provides a [GitHub Action][0] to setup the [Elide][1] runtime within your workflows.
## Usage
**Install the latest Elide version and add it to the `PATH`**
```yaml
- name: "Setup: Elide"
uses: elide-dev/setup-elide@v2
```
**Install a specific Elide version and add it to the `PATH`**
```yaml
- name: "Setup: Elide"
uses: elide-dev/setup-elide@v2
with:
version: 1.0.0-beta1 # any tag from the `elide-dev/releases` repo; omit for latest
```
**Install Elide but don't add it to the `PATH`**
```yaml
- name: "Setup: Elide"
uses: elide-dev/setup-elide@v2
with:
export_path: false
```
## Options
The full suite of available options are below.
| Option | Type | Default | Description |
| ------------- | ------------ | ------------------------- | -------------------------------------------- |
| `version` | `string` | `latest` | Version to install; defaults to `latest` |
| `os` | `string` | (Current) | OS to target; defaults to current platform |
| `arch` | `string` | (Current) | Arch to target; defaults to current platform |
| `force` | `boolean` | `false` | Force installation over existing binary |
| `prewarm` | `boolean` | `true` | Warm up the runtime after installing |
| `token` | `string` | `${{ env.GITHUB_TOKEN }}` | GitHub token to use for fetching assets |
| `export_path` | `boolean` | `true` | Whether to install Elide onto the `PATH` |
**Options for `os`** (support varies)
- `darwin`, `mac`, `macos`
- `windows`, `win32`
- `linux`
**Options for `arch`** (support varies)
- `amd64`, `x64`, `x86_64`
- `arm64`, `aarch64`
**Full configuration sample with defaults**
```yaml
- name: "Setup: Elide"
uses: elide-dev/setup-elide@v1
with:
version: latest
os: linux
arch: amd64
force: false
prewarm: true
export_path: true
```
> [!IMPORTANT]
> Elide supports Linux on amd64 and macOS on amd64/aarch64 at this time. Windows and Linux/aarch64 support are forthcoming.
## What is Elide?
Elide is a new runtime and framework designed for the polyglot era. Mix and match languages including JavaScript, Python, Ruby, and JVM, with the ability to share objects between them. It's fast: Elide can execute Python at up to 3x the speed of CPython, Ruby at up to 22x vs. CRuby, and JavaScript at up to 75x the speed of Node. Elide already beats Node, Deno, and Bun under benchmark.
- **Visit [elide.dev][1]**, our website, which runs on Elide
- **Watch the [launch video][2]** for demos, benchmarks, and a full feature tour
- **Join the devs on [Discord][3]**, we are always open to new ideas and feedback
[0]: https://github.com/features/actions
[1]: https://elide.dev
[2]: https://www.youtube.com/watch?v=Txl9ryfbCw4
[3]: https://elide.dev/discord