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

Merge pull request #56 from PR0M3TH3AN/codex/update-documentation-and-ensure-newline-in-text-files

Browse Source 
Update docs for collections and views
This commit is contained in:
thePR0M3TH3AN
2025-05-22 08:54:29 -04:00
committed by GitHub
parent 33e24297ef f137541c99
commit 28dd5bc1a1
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,14 +1,26 @@
# Marlin
This repository hosts the Marlin indexing tool.
See [docs/roadmap.md](docs/roadmap.md) for the current delivery roadmap.
See [docs/roadmap.md](docs/roadmap.md) and
[docs/adr/DP-001_schema_v1.1.md](docs/adr/DP-001_schema_v1.1.md)
for the current delivery roadmap and schema.
## CLI Cheatsheet
The full command reference is generated during the build of the CLI. See
[cli-bin/docs/cli_cheatsheet.md](cli-bin/docs/cli_cheatsheet.md).
## Collections and Views
Named **collections** act like playlists of files. Create one with
`marlin coll create <name>`, add files via
`marlin coll add <name> <pattern>` and list contents using
`marlin coll list <name>`.
**Views** save search queries for quick reuse. Save a query with
`marlin view save <view> "tag:todo"`, list all views using
`marlin view list` and execute one with `marlin view exec <view>`.
## License
Licensed under the [MIT License](LICENSE).