Skip to content

Commit

Permalink
(frontend) closes #180; add documentation for using CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
enchant97 committed Jan 31, 2024
1 parent 03dd3db commit b24c7fe
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
4 changes: 2 additions & 2 deletions site/content/docs/usage/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Usage
---
TBA.
WIP (Work In Progress).

While you wait; watch the [official demo video](https://youtu.be/rwL99Ac5g98).
- Watch the [official demo video](https://youtu.be/rwL99Ac5g98).
29 changes: 29 additions & 0 deletions site/content/docs/usage/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: CLI
---

## How To Access
### Docker Install
Access from the official Docker image is easy! We can just use the "exec" command from either "docker" or "docker compose".

Example based off install guide:

```sh
docker compose exec note-mark /note-mark --help
```

#### Notes
Due to using a distro-less base image interactive tty sessions with a shell (sh, bash) are not possible.

### Bare Install
Assuming all of the environment variables are already set and Note Mark is accessible from path:

```sh
note-mark --help
```

## Available Commands
- `serve`: run the web API server, depending on install method may include UI
- `clean`: remove old and unused data
- `user`: add, remove and change user passwords
- `help`: shows the help for CLI

0 comments on commit b24c7fe

Please sign in to comment.