Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,33 @@ utilitarian design, give Stacks a try-- I'd love to hear your thoughts!
<tr><td>New note</td><td><code>&#8984; &#x21E7; + n</code></td></tr>
</table>

**Note:** Items deleted through the UI are permanently removed on app restart.

## CLI

Stacks includes a command-line interface for programmatic access. First, symlink the app binary to your PATH:

```bash
ln -s /Applications/Stacks.app/Contents/MacOS/Stacks ~/.local/bin/stacks
```

<table>
<tr><td>Get top item from most recent stack</td><td><code>stacks</code></td></tr>
<tr><td>Get specific item by ID</td><td><code>stacks {id}</code></td></tr>
<tr><td>Delete top item</td><td><code>stacks --delete</code></td></tr>
<tr><td>Delete specific item</td><td><code>stacks {id} --delete</code></td></tr>
<tr><td>List all stacks (JSONL)</td><td><code>stacks list</code></td></tr>
<tr><td>Raw packet stream (JSONL)</td><td><code>stacks stream</code></td></tr>
<tr><td>Search content*</td><td><code>stacks search {query} [--limit N]</code></td></tr>
<tr><td>View complete structure (JSON)</td><td><code>stacks view</code></td></tr>
<tr><td>View current navigation state (JSON)</td><td><code>stacks view nav</code></td></tr>
<tr><td>List CAS hashes</td><td><code>stacks cas list</code></td></tr>
<tr><td>Get content by hash</td><td><code>stacks cas get {hash}</code></td></tr>
<tr><td>Purge content by hash</td><td><code>stacks cas purge {hash}</code></td></tr>
</table>

*`stacks search` supports [Tantivy QueryParser](https://docs.rs/tantivy/latest/tantivy/query/struct.QueryParser.html) syntax: plain terms (`foo`), phrases (`"exact phrase"`), and boolean logic (`foo AND bar NOT baz`).*

## Development

```bash
Expand Down
16 changes: 16 additions & 0 deletions scripts/check.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/bin/bash

set -euo pipefail

cd "$(dirname "$0")/../src-tauri"

echo "🎨 Checking formatting..."
cargo fmt --check

echo "📎 Running clippy..."
cargo clippy -- -D warnings

echo "🧪 Running tests..."
cargo test

echo "✅ All checks passed!"
2 changes: 1 addition & 1 deletion src-tauri/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "stacks"
version = "0.15.13"
version = "0.15.14-dev"
description = "Stacks"
authors = ["Andy Gayton <andy@thecablelounge.com>"]
license = ""
Expand Down
Loading
Loading