thePR0M3TH3AN/Marlin
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/Marlin.git synced 2025-09-08 07:08:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #61 from PR0M3TH3AN/codex/update-readme-with-new-commands-and-quick-start

Browse Source 
Update README with new commands
This commit is contained in:
thePR0M3TH3AN
2025-05-22 14:24:10 -04:00
committed by GitHub
parent b58ec05e31 a015c1f509
commit 9d0fb86009
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -5,6 +5,12 @@ See [docs/roadmap.md](docs/roadmap.md) and
[docs/adr/DP-001_schema_v1.1.md](docs/adr/DP-001_schema_v1.1.md) [docs/adr/DP-001_schema_v1.1.md](docs/adr/DP-001_schema_v1.1.md)
for the current delivery roadmap and schema. for the current delivery roadmap and schema.
## Quick Start
Follow the short walkthrough in
[docs/marlin_demo.md](docs/marlin_demo.md) to build the
binary and test Marlin on a sample project.
## CLI Cheatsheet ## CLI Cheatsheet
The full command reference is generated during the build of the CLI. See The full command reference is generated during the build of the CLI. See
@@ -21,6 +27,13 @@ Named **collections** act like playlists of files. Create one with
`marlin view save <view> "tag:todo"`, list all views using `marlin view save <view> "tag:todo"`, list all views using
`marlin view list` and execute one with `marlin view exec <view>`. `marlin view list` and execute one with `marlin view exec <view>`.
Other handy commands include:
- `marlin watch <dir>` to keep the index updated in real time.
- `marlin backup run` to create or prune database backups.
- `marlin link add` to relate files with typed edges.
- `marlin annotate add` to attach notes or highlights.
## License ## License
Licensed under the [MIT License](LICENSE). Licensed under the [MIT License](LICENSE).