https://github.com/fbn776/assistscript
AssistScript: A simple and not very useful scripting language inspired by Lisp.
https://github.com/fbn776/assistscript
interpreter lisp new-language programming-language scripting-language typescript
Last synced: about 1 month ago
JSON representation
AssistScript: A simple and not very useful scripting language inspired by Lisp.
- Host: GitHub
- URL: https://github.com/fbn776/assistscript
- Owner: fbn776
- License: mit
- Created: 2023-12-02T18:46:03.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-21T20:49:07.000Z (about 1 year ago)
- Last Synced: 2025-05-13T13:19:31.437Z (about 1 month ago)
- Topics: interpreter, lisp, new-language, programming-language, scripting-language, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/assistscript
- Size: 1.18 MB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
AssistScript
## Table of Contents
- [Introduction 📜](#introduction)
- [Installation📲](#installation)
- [Demos ▶️](#demos)
- [Sample Program - Bubble Sort 🔢](#sample-program---bubble-sort)
- [Usage ✍](#usage)
- [Using terminal 💻](#using-terminal)
- [REPL mode ⌨️](#repl-mode)
- [File Mode 📂](#file-mode)
- [Using the API 💻](#using-the-api)
- [Want to learn more? 🏫](#want-to-learn-more)
- [License](#license)
---
## Introduction📜
AssistScript is a simple scripting(?) language that I made for fun.
Not very useful, but it's fun to play around with.
Initially started as a joke, and as time passed it became a fun project to work on.
The language is a straightforward, all you have to do is to specify a command and its arguments.
The basic syntax is:
```asrc
...
```
eg:
```asrc
add 10 20 40
```
Outputs 70
>✨ Want to try out the language? Check out the [AssistScript Runner](https://asrc-online.vercel.app/)
---
## Installation📲
You can install AssistScript using npm.
```bash
npm install -g assistscript
```
This installs the AssistScript CLI globally on your system.
If you don't want AssistScript to be installed globally,
you can omit the `-g` flag or use `npx` to run AssistScript without installing it.
---
## Demos▶️
Want to see what the language can do? Check out the [demos🧪](./demos) directory for some examples.
These demos are simple programs that demonstrate the language's features. You can run them using the CLI.
### Sample Program - Bubble Sort🔢
Here is bubble sort in AssistScript:
```asrc
(array arr 4 5 2 4 5 6 7 1)
(for (set i 0) (lt (get i) (len arr)) (incr i) (
(for (set j 0) (lt (get j) (sub (len arr) (get i) 1)) (incr j) (
(if (gt
(index arr (get j))
(index arr (add (get j) 1))
) (
(set temp (index arr (get j)))
(set-arr arr (get j) (index arr (add (get j) 1)))
(set-arr arr (add (get j) 1) (get temp))
))
))
))
(for (set i 0) (lt (get i) (len arr)) (incr i) (
(print (index arr (get i)))
))
```
Output:
```text
1
2
4
4
5
5
6
7
```
Visit the [online AssistScript runner](https://asrc-online.vercel.app) to run assistscript programs online.
---
## Usage✍
AssistScript can be used in multiple ways.
You can use it as a standalone program in the terminal using the AssistScript CLI,
or you can use it inside your JavaScript code.
### Using terminal💻
You can run AssistScript using the terminal. The AssistScript package comes with a command-line interface to run
AssistScript files. It also has a REPL mode to run commands interactively.
```bash
# Without installing the package
npx assistscript
```
OR
```bash
# Once the package is installed
aslangc
```
The above commands, once executed, will show the help menu for the CLI.
> 📝 You can interchangeably use `aslangc` and `assistscript` in the terminal.
#### REPL mode⌨️
You can run the REPL mode by using the `-r` or `--repl` flag.
```bash
aslangc -r
```
#### File Mode📂
You can run AssistScript(.asrc) files using the CLI by providing the path to the file.
```bash
aslangc
```
### Using the API💻
You can also use AssistScript in your JavaScript code, for this AssistScript exposes a simple API.
The `AssistScript` class is the main class that you can use run AssistScript code.
```ts
import {AssistScript} from 'assistscript';
const as = new AssistScript();
// Prints 70
console.log(as.run('add 10 20 30'));
// Prints 50 <- (100 - 20 - (10 + 20))
console.log(as.run('sub 100 20 (add 10 20)'));
```
---
## Want to learn more?🏫
Check out the [documentation📃](./docs/README.md) for more information on the language and its features.
- To learn more about the implementations, check out the [implementation](./docs/implementations/README.md).
- For additional information, check out the [additional info](./docs/additionals/README.md).
- To get started with creating custom commands, check out the [custom commands](./docs/additionals/Create-custom-commands.md).
- To create custom context, check out the [custom context](./docs/additionals/Create-custom-context.md).
---
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
---
Made with 💙 by [fbn776](https://febinnelson.me)