Skip to content

Commit

Permalink
Document commands
Browse files Browse the repository at this point in the history
  • Loading branch information
logandhillon committed Jul 12, 2024
1 parent 0d5a036 commit 719d94e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[❮ Back](..)

# BDSH Commands

bdsh contains many commands for you to use, packed inside the shell.

Some are self explainatory, others will be explained here.

See the order that bdsh finds and runs commands [here](file-structure.md#binary-execution).

## ld (list directory)

Prints all files and folders in the current directory, or the directory passed as an argument

## def (define)

Binds keywords to definitions. Similar to a shortcut, but for commands.

### Example (`hello -> echo hi`)

```bdsh
/$ def hello echo hi
defined 'hello' to run 'echo hi'
/$ hello
hi
```

## throw

Throws an exception.

## go

Goes to a directory, similar to `cd` on other operating systems.

## peek

Peeks into a file, and prints its contents to the terminal.
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@
- [BadOS Dynamic Shell Package Library (bpl)](bpl.md)
- [BadOS Package Manager (bpm)](bpm.md)
- [BadBandSSH (bssh)](bssh.md)
- [BDSH Commands](commands.md)
- [System File Structure](file-structure.md)
- [BadOS Dynamic Shell (bdsh)](index.md)


## Installation

1. **Download the latest release**
Expand Down

0 comments on commit 719d94e

Please sign in to comment.