lkn
/
ollie
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: add server/usage docs; rename ollie.el to ellie.el; update submodule 

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Levi Neely 2026-04-18 13:31:58 +02:00
parent 446b051ac9
commit 735753bac9
3 changed files with 45 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -16,9 +16,7 @@ Or after cloning:
git submodule update --init --recursive
```
## Building
Build everything from the monorepo root:
Build and install everything from the monorepo root:
```bash
mk
@ -32,12 +30,14 @@ mk tui # Build terminal UI
mk 9p # Build 9p filesystem server
```
For Emacs Lisp, copy `el/ollie.el` into your own Emacs configuration directory, and:
For Emacs Lisp, copy `el/ellie.el` into your own Emacs configuration directory, and:
```lisp
(require 'ollie)
(require 'ellie)
```
See [doc/USAGE.md](doc/USAGE.md) for usage instructions.
## Configuration
### Environment: `~/.config/ollie/env`

40
doc/USAGE.md
View File

@ -1,6 +1,44 @@
# Usage
Examples assume `$OLLIE` is set to the ollie mount point (default: `$HOME/mnt/ollie`).
## Server
### Start and stop
```sh
olliesrv start # start in background (daemonizes)
olliesrv fgstart # start in foreground
olliesrv stop # stop the daemon
olliesrv status # check if running
```
By default the server mounts at `$HOME/mnt/ollie`. Override with `-mount`:
```sh
olliesrv start -mount /tmp/ollie
```
### TCP listener
To also accept connections over TCP (e.g. for remote access):
```sh
olliesrv start -tcp :9564
```
### Debug logging
Log level is controlled by `OLLIE_LOG` (default: `warn`). Set to `debug` for verbose output:
```sh
OLLIE_LOG=debug olliesrv fgstart
```
Valid levels: `debug`, `info`, `warn`, `error`. Per-subsystem overrides follow the pattern
`OLLIE_<TAG>_LOG=debug` where `<TAG>` matches the logger's tag (e.g. `OLLIE_SESSION_LOG`).
---
Examples below assume `$OLLIE` is set to the ollie mount point (default: `$HOME/mnt/ollie`).
Scripts under `s/`, `b/`, and `u/` are available directly via the mounted filesystem
after running `mk && mk scripts`.

2
el

@ -1 +1 @@
Subproject commit 0e89242e8351204c42c59dade966de5643954054
Subproject commit db541185131834db96a931478b5525eb3cc2dfb8