Augmented View 0.6.6

Built and attested by GitHub Actions, and a fix from Obsidian's CSS review. The plugin works as in 0.6.5.

What changed since 0.6.5

• Built and attested by GitHub Actions. 0.6.5 was built on the author's computer while Actions could not run. From this release, main.js, manifest.json and styles.css are built by GitHub Actions from the tagged source, and each carries an artifact attestation of its build provenance. Check a downloaded file with gh attestation verify main.js --repo Gameboard-dev/obsidian-augmented-view.
• CSS review fix. The stylesheet no longer uses box-decoration-break, which Obsidian's review reports as only partly supported. The one visible difference: a mark that wraps onto the next line has square corners where the line breaks, not rounded ones. The marks have no padding or border, so nothing else changes.

The server

Unchanged. The server programs, their checksums and licence files stay on server-0.6.2, so a server you have installed needs nothing.

Requirements and installation

As in 0.6.5: Obsidian 1.8.7 or later, desktop only, and the model server for your computer. Step by step: Installation.

Augmented View 0.6.5

Copy a selection with its highlights, fixes from Obsidian's plugin review, and the server on a release page of its own. (0.6.4 was tagged but never published; this release carries its changes.)

What changed since 0.6.3

• Copy with Augmented View highlights. Select text in a note with a colour code, right-click and choose Copy with Augmented View highlights (or run the command Copy selection with highlights). The selection goes to the clipboard as Markdown, with each coloured sentence wrapped in a marker, ~={#FFD2D2, Claims}…=~, or, if you prefer, <mark data-colour="#FFD2D2" data-category="Claims">…</mark>; phrase colours can be included too. The colours are the ones the editor shows (the note's colour code, the sensitivity, the rules); where the selection cuts a sentence, the marker covers the selected part only, and colours not computed yet are computed first. The markers keep code, maths, links, footnotes, lists, tables and block ids intact. The note is never changed and nothing is written but the clipboard. The menu item can be hidden in Settings → Augmented View → Copy with highlights. See Copying with highlights.
• Styles: the floating key folds without !important in the stylesheet (the plugin clears and restores the height you gave it), the settings' contents column uses gap, and marks use the unprefixed box-decoration-break.
• Same marks, shared code: the code that draws the marks as paragraphs come into view, in the editor and in Reading view, and the copy with highlights now live in a shared library crate; nothing visible changes and it is no slower.
• The server has its own release page. This release carries only the plugin's files, main.js, manifest.json and styles.css, as Obsidian asks. The server programs, their checksums and licence files are on server-0.6.2; the server is unchanged since 0.6.2, so an installed one needs nothing.

Requirements and installation

As in 0.6.2: Obsidian 1.8.7 or later, desktop only, and the model server for your computer. Step by step: Installation.

Augmented View 0.6.3

A fix for the settings tab.

• Settings: the Contents column no longer lets a scrolling list (such as the Models list) be drawn over the section after it.
• Docs: the CPU server's file name on the install page now matches the release asset.

The plugin code (main.js) and both server programs are unchanged from 0.6.2; only styles.css and the version changed. Requirements and installation are as in 0.6.2.

Augmented View 0.6.2

Augmented View 0.6.2

Colours each sentence of a note by the role it plays (a claim, a finding, a limitation, a signpost …) and key phrases by kind, for skim reading, with local models on your own computer. The note itself is never changed.

What changed since 0.6.1

• The server can download its models when you start it yourself. Started by hand in a terminal with models missing, the server lists them (size, page, licence, folder and the total) and asks Download them now? [y/N]. "y" downloads them, checked and resumable as with --download all, and then starts the server; any other answer downloads nothing and prints the command to run later. --no-prompt turns the question off. When the plugin starts the server nothing changes: it never asks and never downloads. See The terminal question.
• Better sentence boundaries for sentence colours. A full stop after a citation or a link now ends the sentence; abbreviations such as "et al." and pieces cut at a colon or a line break are joined to the sentence they belong to; a sentence that opens with bold or italic starts at its markers. Block ids and LaTeX spacing are no longer passed to the model.
• "None of these". The sentence model is told to choose "None of these" when no colour fits well, so fewer sentences get a colour that does not suit them. A colour you hide in the key can serve as a place for such sentences.
• Settings contents. The settings tab has a Contents column at the side listing every section, which stays in view as you scroll.
• Documentation moved from one long README into docs/: installation, usage, colour codes and rules, settings, the server, models, GPU and memory, performance, privacy and security, troubleshooting, building and licences, with a Disclosures page that goes through Obsidian's developer policies point by point.
• When a model download is refused for lack of a Hugging Face token, the message now names the HF_TOKEN environment variable. None of the default models needs a token.

Requirements

• Obsidian 1.8.7 or later, desktop only (the plugin starts the server as a separate program).
• The prebuilt server: Windows x64, a CPU with AVX2 (x86-64-v3: Intel Haswell or AMD Excavator, 2013 onwards, or later).
  • On the GPU: an NVIDIA GPU of compute capability 8.0 or higher (RTX 30 series or newer) with its driver and CUDA 13's cuBLAS and cuRAND libraries, and about 4 GB of free GPU memory. Without them the server runs on the CPU by itself, more slowly, and says why.
  • On the CPU: about 5 GB of free memory.
• macOS and Linux: build the server from server/ (Building from source); written for but not yet tested.
• Disk: the models are downloaded once (about 8.5 GB downloaded, about 2.9 GB kept; 0.84 GB more for phrase colours).

Install

1. Copy main.js, manifest.json and styles.css into <vault>/.obsidian/plugins/augmented-view/ (or install from Obsidian's community plugins once listed), and enable the plugin.
2. Download the server, augmented-view-server-windows-x64.exe (CUDA; uses the CPU by itself when CUDA is missing), and put it in the same folder as augmented-view-server.exe (or keep its name and set it in Settings → Augmented View → This device → Server). On a computer without an NVIDIA GPU, augmented-view-server-cpu-windows-x64.exe is smaller: save it as augmented-view-server.exe, or as augmented-view-server-cpu.exe beside the CUDA one (the CPU server setting). Check each against its .sha256 file:
   • PowerShell: Get-FileHash .\augmented-view-server-windows-x64.exe -Algorithm SHA256
   • Command Prompt: certutil -hashfile augmented-view-server-windows-x64.exe SHA256
3. Keep augmented-view-server-LICENSE.txt and augmented-view-server-THIRD-PARTY-LICENSES.txt beside it.
4. Download the models, in either of two ways:
   • run the server yourself in a terminal and answer "y" to its question, or
   • copy the download command from Settings → Augmented View → Models and run it in a terminal, for example & "<vault>\.obsidian\plugins\augmented-view\augmented-view-server.exe" --download all, then press Check again.
5. Open a note, choose a colour code in the floating key, and read.

The plugin talks only to its server on 127.0.0.1, and the server downloads models (from Hugging Face and LINDAT) only when you run its download command or answer yes in its terminal. Details: Disclosures.

Augmented View 0.6.1

Augmented View 0.6.1

Colours each sentence of a note by the role it plays (a claim, a finding, a limitation, a signpost …) and key phrases by kind, for skim reading, with local models on your own computer. The note itself is never changed.

What changed since 0.6.0

• Rules for each colour (Settings → Augmented View → Rules, or a colour row's list button). Give a colour your own words or a pattern (a regular expression) that forces it on the sentences they match or forbids it there. A Forbid rule wins, then the first colour whose Force rule matches, then the model's choice; a phrase colour's rules mark words or drop the model's phrases. Rules apply at once, also to cached paragraphs, in Live Preview, Source mode and Reading view, and are never sent to the server. Patterns are checked as you type and cannot hang Obsidian (a linear-time engine, length and size limits). Test on a sentence shows what the rules do. See the README's Rules section.
• The plugin never downloads anything. It no longer offers to download the models: when models are missing, the server says which and stops, and Settings → Augmented View → Models lists each model (purpose, size, licence, page, folder, files) with the download command for you to run in a terminal. The server's --download run pins each model to a published commit and checks every file's size and checksum, and resumes after an interruption.
• Licence files ship with the server: augmented-view-server-LICENSE.txt and augmented-view-server-THIRD-PARTY-LICENSES.txt (the crates' licences and the native code compiled in).
• Disclosures and compliance in the README: network use, files outside the vault, no account, payment, ads or telemetry, and how the plugin meets Obsidian's developer policies.
• The floating key's check boxes show or hide each colour of the note's code.
• The manifest's minimum Obsidian version follows the APIs used (1.8.7).

Requirements

• Obsidian 1.8.7 or later, desktop only (the plugin starts the server as a separate program).
• The prebuilt server: Windows x64, a CPU with AVX2 (x86-64-v3: Intel Haswell or AMD Excavator, 2013 onwards, or later).
  • On the GPU: an NVIDIA GPU of compute capability 8.0 or higher (RTX 30 series or newer) with its driver and CUDA 13's cuBLAS and cuRAND libraries, and about 4 GB of free GPU memory. Without them the server runs on the CPU by itself, more slowly, and says why.
  • On the CPU: about 5 GB of free memory.
• macOS and Linux: build the server from server/ (README, "Build and deploy"); written for but not yet tested.
• Disk: the models are downloaded once by the command you run (about 8.5 GB downloaded, about 2.9 GB kept; 0.84 GB more for phrase colours).

Install

1. Copy main.js, manifest.json and styles.css into <vault>/.obsidian/plugins/augmented-view/ (or install from Obsidian's community plugins once listed), and enable the plugin.
2. Download the server, augmented-view-server-windows-x64.exe (CUDA; uses the CPU by itself when CUDA is missing), and put it in the same folder as augmented-view-server.exe (or keep its name and set it in Settings → Augmented View → This device → Server). On a computer without an NVIDIA GPU, augmented-view-server-cpu-windows-x64.exe is smaller: save it as augmented-view-server.exe, or as augmented-view-server-cpu.exe beside the CUDA one (the CPU server setting). Check each against its .sha256 file:
   • PowerShell: Get-FileHash .\augmented-view-server-windows-x64.exe -Algorithm SHA256
   • Command Prompt: certutil -hashfile augmented-view-server-windows-x64.exe SHA256
3. Keep augmented-view-server-LICENSE.txt and augmented-view-server-THIRD-PARTY-LICENSES.txt beside it.
4. Download the models: start the server from the status bar's "AugView" menu; it lists what is missing, and Settings → Augmented View → Models shows the command to copy and run in a terminal, for example
   & "<vault>\.obsidian\plugins\augmented-view\augmented-view-server.exe" --download all
   Then press Check again, or start the server from the status bar.
5. Open a note, choose a colour code in the floating key, and read.

What the plugin and the server connect to, and which files they write outside the vault, is set out in the README's Disclosures and compliance section: the plugin talks only to its server on 127.0.0.1, and the server downloads models (from Hugging Face and LINDAT) only when you run its download command.

Augmented View server 0.6.2

The Augmented View server programs, on a release page of their own from plugin 0.6.4 on (the plugin's releases carry only the three files Obsidian installs).

These are the same programs as in plugin releases 0.6.2 and 0.6.3 (same checksums); nothing changed.

• augmented-view-server-windows-x64.exe: Windows x64 with an NVIDIA GPU (CUDA, compute capability 8.0 or later); falls back to the CPU when CUDA is missing.
• augmented-view-server-cpu-windows-x64.exe: Windows x64 without an NVIDIA GPU.
• Each .sha256 file holds the program's checksum, to check the download by hand.
• augmented-view-server-LICENSE.txt and augmented-view-server-THIRD-PARTY-LICENSES.txt: the licences that come with the programs.

Where to put the program, and how its models are downloaded: installation and the server. The plugin itself never downloads anything.