Skip to content
This repository has been archived by the owner on Jul 29, 2022. It is now read-only.

vrtbl/aspen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Note: We have moved aspen to the Passerine monorepo, which can be found here. As a result, this repository is out of date and has been archived.

aspen

Passerine's package manager.

Getting Started

To install the aspen command, run this in the shell of your choice:

bash <(curl -sSf https://www.passerine.io/install.sh)

Note: The above shell script no longer works. We recommend you use this instead:

cargo install passerine-aspen

This requires git and a recent version of Cargo to work. You can inspect the contents of install.sh first if you want, we're not trying to play any tricks on you.

  1. Start a new Passerine project using Aspen:
aspen new example
  1. This will create a project named example in the current directory. Open this project and look through it in your editor of choice.
  2. To run the project:
cd example
aspen run

aspen run and most other commands optionally take a path to the project root.

Commands

NOTE: Not all commands are implemented ATM. Commands in bold are partially or wholly implemented.

Command Result
update Updates the Passerine toolchain.
new Creates a new Passerine package.
publish Publishes package to the registries in Aspen.toml.
pull Pulls fresh packages from the registries in Aspen.toml.
add Adds a dependency to Aspen.toml.
run Builds and runs the corresponding Passerine package.
repl Opens a fresh repl session.
test Builds and runs the package's tests.
bench Builds and runs the package's benchmarks.
doc Builds the package's documentation.
debug Builds and runs the package in interactive debug mode.

An optional path to the project root may be provided.