Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-sandbox-project/sandbox
⏳ A Command-Line Sandbox Tester for Different Environments
https://github.com/the-sandbox-project/sandbox
bug-fixing command-line command-line-tool debugging debugging-tool rust rust-lang sandbox sandbox-environment sandbox-playground testing testing-tools
Last synced: about 2 months ago
JSON representation
⏳ A Command-Line Sandbox Tester for Different Environments
- Host: GitHub
- URL: https://github.com/the-sandbox-project/sandbox
- Owner: the-sandbox-project
- License: gpl-3.0
- Created: 2023-04-25T11:10:27.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-15T18:21:30.000Z (over 1 year ago)
- Last Synced: 2024-02-13T21:44:09.849Z (10 months ago)
- Topics: bug-fixing, command-line, command-line-tool, debugging, debugging-tool, rust, rust-lang, sandbox, sandbox-environment, sandbox-playground, testing, testing-tools
- Language: Rust
- Homepage: https://sandbox.cli.rs
- Size: 134 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sandbox
> Welcome to the Sandbox Project, a way to test different programming languages and projects
[](https://asciinema.org/a/kFOxcFwQDuUXJbHQAayYfoQeQ)
Table of Contents
========
* [Installation](#installation)
* [Usage](#usage)
* [Configuration](#configuration)
Installation
========
### Windows
Head to the [releases](https://github.com/the-sandbox-project/sandbox/releases) page and download the [MSI build](https://github.com/the-sandbox-project/sandbox/releases/download/v1.0.1/sandbox-0.1.1-x86_64.msi). From there, install it like any other program!
### MacOS / Linux
> **Note**
> Plans have been made to add sandbox to [Homebrew](https://brew.sh) and the [AUR](https://aur.archlinux.org)
```
$ wget https://github.com/the-sandbox-project/sandbox/releases/download/v0.2.1/sandbox -O ~/.local/bin
```
Usage
========
### Help
> sandbox --help
This is the default Help command, running will produce:
```
Usage: sandbox [OPTIONS]
Options:
-n, --new Create a New Environment [default: ]
-S, --search Search for Environment [default: ]
-I, --install Search for Environment [default: ]
-U, --uninstall Create a New Environment [default: ]
-R, --reinstall Reinstall an Environment [default: ]
-C, --clearcache Clear the Install Cache
-h, --help Print help
-V, --version Print version
```
### New
> sandbox --new ``
This is the New command, it will start a new session with a specified environment and go back to a previously edited environment if one has been created before.
Ex:
```
$ sandbox --new rust-min
```
Output:
```
__
___ ___ ___ __ __ /\_\ ___ ___
/ _ `\ / __`\ / __`\/\ \/\ \\/\ \ / __` __`\
/\ \/\ \/\ __//\ \_\ \ \ \_/ |\ \ \/\ \/\ \/\ \
\ \_\ \_\ \____\ \____/\ \___/ \ \_\ \_\ \_\ \_\
\/_/\/_/\/____/\/___/ \/__/ \/_/\/_/\/_/\/_/
(rust-min)
📂 Find File
📄 Recents
🔎 Find Word
🔖 Bookmarks
↗️ Last Session
```
### Search
> sandbox --search ``
This is the Search command, you will use this to search the [templates repository](https://github.com/the-sandbox-project/sandbox-templates) and find a template that interests you!
Ex:
```
$ sandbox --search minimal
```
Output:
```bash
❌ Default Rust Project (rust-min) - Minimal Rust Project, Created with Cargo new
✅ Default Golang Project (go-min) - Minimal Golang Project
Environments That Match Query minimal
Install any of these with sandbox install
```
### Install
> sandbox --install ``
This is the install command! You will use this to install the environments you find in the search field.
Ex:
```
$ sandbox --install rust-min
```
Output:
```
[00:00:00] [#######################################] 340B/340B (0.0s)
Installed rust-min! Test it out with: sandbox --new rust-min
```
Configuration
========
Sandbox has a configuration file
### Windows
Windows's Sandbox Configuration file is stored in the Appdata:
> %APPDATA%/sandbox/sandbox.yml
### MacOS / Linux
MacOS and Linux share the same config file location! You are able to find it here:
> ~/.config/sandbox/sandbox.yml
```yml
# sandbox.yml
editor:
editorName: "code"
```
> **Note:** the `editorName` field is the editor command for any editor, for example: Neovim would be `nvim`