https://github.com/mattwparas/steel
An embedded scheme interpreter in Rust
https://github.com/mattwparas/steel
contracts lisp programming-language racket rust scheme scripting-language transducers
Last synced: 3 months ago
JSON representation
An embedded scheme interpreter in Rust
- Host: GitHub
- URL: https://github.com/mattwparas/steel
- Owner: mattwparas
- License: apache-2.0
- Created: 2020-02-20T17:39:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T16:38:30.000Z (about 1 year ago)
- Last Synced: 2025-03-28T20:07:56.344Z (about 1 year ago)
- Topics: contracts, lisp, programming-language, racket, rust, scheme, scripting-language, transducers
- Language: Rust
- Homepage:
- Size: 7.41 MB
- Stars: 1,605
- Watchers: 15
- Forks: 70
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust-tools - steel
- awesome-lisp-family - Steel - commit](https://img.shields.io/github/last-commit/mattwparas/steel.svg)](https://github.com/mattwparas/steel) | S | | (Languages / Rust)
- awesome-lisp-languages - Steel - S] embedded scheme interpreter in Rust, inspired by Racket (Languages / Rust)
- awesome-helix - Steel - Scheme-based scripting language for configuration and extensibility. (Tools and Utilities)
README
# Steel
An embeddable and extensible scheme dialect built in Rust.
[](https://coveralls.io/github/mattwparas/steel?branch=master)
[](https://discord.gg/WwFRXdN6HU)
[](https://matrix.to/#/#steel:matrix.org)
## About
`Steel` is an embeddable scheme interpreter, with a standalone interpreter/REPL
included as well. The language is implemented as a bytecode virtual machine. At
the moment, it is mostly compliant with R5RS, only missing `let-syntax` support.
Support for R7Rs is underway.
> **Warning**
> The API is relatively stable, however it may change at any time while pre 1.0.
> Care will be taken to keep things backwards compatible where possible.
## Features
- [R5RS](https://standards.scheme.org/official/r5rs.pdf) support
- Modules, using `require` and `provide` much like Racket.
- `syntax-rules` and `syntax-case` macros.
- Easy integration with native Rust functions and structs, either through
embedding or via FFI.
- Higher order Contracts
- Built in immutable data structures, including:
- lists
- vectors
- hashmaps
- hashsets
For more details, see the [book](https://mattwparas.github.io/steel/book).
## Getting Started
This github repository contains a CLI interpreter. To try it out on the online
playground, go to the [Steel playground](https://mattwparas.github.io/steel-playground/).
To get started using a REPL with the crates, make sure you first have Rust
installed.
Then, clone the repo and run the following command:
```bash
cargo run
```
This will launch a REPL instance that looks something like this:
### Full install
If you'd like to install everything, just run the following command:
```bash
cargo xtask install
```
This will install:
- The steel interpreter, `steel`
- The package manager, `forge`
- The dylib installer, `cargo-steel-lib` (also available via the interpreter)
- The steel language server
- The standard library, found under the `cogs` directory
#### Nix
Steel can also be installed with Nix. Add the following to your Home Manager
config:
```nix
home.packages = [
pkgs.steel
];
```
### Packages
If you would like to customize the location of installed packages, please set
the `STEEL_HOME` environment variable. Steel currently follows XDG if present,
and otherwise assumes the default of `$HOME/.steel` if the `STEEL_HOME`
environment variable is not already set.
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
See [CONTRIBUTING.md](./CONTRIBUTING.md).