Metadata-Version: 2.4
Name: forge-me-notes
Version: 0.2.0
Summary: An LLM-assisted workflow tool for Obsidian vaults.
Author-email: DenvaDude <DenvaDude@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Eric
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.12
Requires-Dist: tomli_w
Requires-Dist: pyyaml
Dynamic: license-file

# forge-me-notes (`fmn`)

An LLM-assisted workflow tool for Obsidian vaults.

`fmn` is a minimal CLI that bridges Obsidian and an LLM chat session. It packs your vault into a context file, you hand that to an LLM, the LLM produces structured notes, and `fmn` writes them back into the vault — cleanly, non-destructively, and with a dry-run by default.

---

## Command status

| Command      | Status |
|--------------|--------|
| `fmn`        | done   |
| `fmn config` | done   |
| `fmn init`   | done   |
| `fmn pack`   | done   |
| `fmn write`  | done   |

---

## Quick Start

**Install**

```bash
pip install forge-me-notes
```

**Configure your vault**

```bash
fmn config --vault ~/vaults/my-vault
```

**Scaffold the vault** (copies templates and the session prompt into the vault)

```bash
fmn init
```

**Pack the vault** (produces a context file to upload to your LLM)

```bash
fmn pack
```

**Write notes back** (dry run by default — review before applying)

```bash
fmn write notes.yaml
fmn write notes.yaml --apply
```

---

## How it works

1. `fmn pack` scans your vault and writes a context pack.
2. You upload the context pack to an LLM chat session and have a conversation.
3. The LLM produces a `notes.yaml` file following your vault's schema.
4. `fmn write notes.yaml` validates and applies the notes to your vault.

`fmn` never deletes content. `create` skips existing files unless `--force` is passed. `update` merges frontmatter and preserves body content unless a new body is provided.

---

## Living documentation

Full documentation is maintained in the [fmn-docs](https://codeberg.org/DenvaDude/fmn-docs) repository — a live Obsidian vault kept up to date by `fmn` itself.

---

## Regression suite

```bash
bash tests/regression/run_regression.sh
```

Wipes and rebuilds `tests/regression/vault/` from fixtures. Open that folder in Obsidian to inspect results.

---

## License

MIT — see [LICENSE](LICENSE).
