architext 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f01f07f6d9ef1e104d4c8f5dc9575faf85864ec4a16e26e9776033e6bfb9c0df
+  data.tar.gz: 9b3abb2535fe6d4145173a2b6d4a8dfb9d4857f5dba6f13e3d0dd484e67ac15f
+SHA512:
+  metadata.gz: ba45236c8562e14652ff0b1404e5ca44b6b1f485f11fd23d288bac35a61260437abd4fc72e13f95e0e91385ca95d6342912ad14a7c9730ee80ba6d11f1271458
+  data.tar.gz: 91a02ffeb556817e1161e3560885591a7cf917f92e7e0ff8e11c99ab8f823e0c2889cc80ec4a853b083473c0691af7056265d8b2d37824918294146b07f5fa7b

data/CHANGELOG.md

@@ -0,0 +1,84 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-05-16
+
+### Changed
+- Naming normalization release: align gem/library/executable naming around `architext` following RubyGems consistent naming guidance.
+- Rename internal Ruby namespace from `ObsidianContext` to `Architext`.
+- Rename library layout from `lib/obsctx/*` to `lib/architext/*` with `lib/architext.rb` as the canonical entrypoint.
+- Standardize executable usage on `bin/architext` and remove the legacy `obsctx` executable from the gem package.
+- Standardize Obsidian CLI override environment variable on `ARCHITEXT_OBSIDIAN`.
+
+## [0.1.6] - 2026-05-13
+
+### Fixed
+- Replace the Windows selector frame with a fixed-height, no-wrap layout to prevent redraw fragments from accumulating in PowerShell.
+- Handle arrow-key escape sequences returned as a single `getch` value as well as byte-by-byte sequences.
+- Account for emoji and wide Unicode characters when truncating candidate paths.
+
+## [0.1.5] - 2026-05-13
+
+### Fixed
+- Smooth selector redraws on Windows by using the alternate screen and repainting the frame in place instead of clearing the whole terminal on every navigation key.
+- Improve arrow-key parsing for Windows PowerShell and other VT-style terminals.
+
+## [0.1.4] - 2026-05-13
+
+### Fixed
+- Route Obsidian CLI calls through PowerShell on Windows so Ruby captures the same search output shown in an interactive terminal.
+
+## [0.1.3] - 2026-05-13
+
+### Fixed
+- Prefer Obsidian CLI `format=json` search output before text output, matching the reliable Windows CLI path.
+- Normalize captured Obsidian CLI output as UTF-8 before parsing so emoji-heavy Windows vault paths survive Ruby process capture.
+
+## [0.1.2] - 2026-05-13
+
+### Added
+- Startup vault configuration flow: type `v` at search prompt to open vault config mode.
+- Clear startup vault diagnostics showing:
+  - active vault and source
+  - saved default vault
+  - default vault config path
+- Obsidian CLI pre-search connection diagnostics (`version`, resolved vault summary, executable path).
+- `--diagnose` CLI flag to print vault/CLI connection details without running a search.
+- No-results diagnostics now include vault source, config path, and Obsidian CLI executable reference.
+
+### Changed
+- Gem package name normalized to lowercase `architext` for `gem install/uninstall architext`.
+- Context selection header now shows explicit vault source labels (`--vault`, `saved default`, `session`, `obsidian default`).
+- `(default)` vault label replaced with clearer "none selected (obsidian default)" messaging.
+
+## [0.1.1] - 2026-05-13
+
+### Added
+- Cross-platform clipboard support for macOS, Windows, and Linux command-line environments.
+- `--version` flag to print the running executable version.
+- Windows and Linux platform notes in README.
+- CI matrix coverage for `ubuntu-latest`, `macos-latest`, and `windows-latest`.
+- Persistent default vault management via `--set-default-vault` and `--clear-default-vault`.
+- TUI vault control (`v`) plus active-vault visibility in the selector header.
+- Splash intro enhancements: branded subtitle, centered version line, and short glow animation.
+
+### Changed
+- TUI input handling for better Windows key compatibility.
+- Terminal capability detection to avoid unsupported rendering features in some terminals.
+- `q` during selection now returns to the search prompt instead of exiting immediately.
+- No-results feedback now includes vault context and remediation tips.
+
+## [0.1.0] - 2026-05-13
+
+### Added
+- Initial release of `architext`.
+- TUI for interactive Obsidian note selection.
+- CLI support for queries and vault selection.
+- GitHub Actions CI workflow.
+- Professional repository documentation (`CHANGELOG.md`).
+- RuboCop integration for linting.
+- `bin/setup` script for easier development environment configuration.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Can Ur (CanPixel)
+
+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.

data/README.md

@@ -0,0 +1,196 @@
+# ARCHiTEXT
+
+<p align="center">
+  <img src="assets/logo.svg" alt="ARCHiTEXT Logo" width="200">
+  <br>
+  <b>The bridge between your Obsidian vault and LLMs.</b>
+  <br>
+  <i>A high-performance Ruby TUI for context stitching.</i>
+</p>
+
+<p align="center">
+  <a href="https://github.com/CanPixel/ARCHiTEXT/actions/workflows/ci.yml">
+    <img src="https://github.com/CanPixel/ARCHiTEXT/actions/workflows/ci.yml/badge.svg" alt="CI Status">
+  </a>
+  <a href="https://rubygems.org/gems/architext">
+    <img src="https://img.shields.io/badge/version-v0.2.0-5BE8B8.svg" alt="Version 0.2.0">
+  </a>
+  <a href="LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+  </a>
+  <img src="https://img.shields.io/badge/maintained-yes-green.svg" alt="Maintained">
+</p>
+
+---
+
+<img src="assets/social-preview.svg" alt="ARCHiTEXT Social Preview" width="1080">
+
+`ARCHiTEXT` is a standalone Ruby TUI for stitching Obsidian notes into an LLM-friendly Markdown context bundle. It uses the official `obsidian` CLI as the source of truth for vault search and file reads, providing a visual terminal interface for selecting notes.
+
+## 🚀 Quick Start
+
+```sh
+# Start the interactive search and selection flow
+architext
+```
+
+ARCHiTEXT will detect your active Obsidian vault, ask for a search query, then open a picker where you can select notes and copy the stitched context bundle to your clipboard.
+
+Common next steps:
+
+```sh
+# Search with a specific query
+architext --query "game"
+
+# Search a specific vault
+architext --vault "Main Vault" --query "project"
+
+# Print the bundle instead of copying it
+architext --query "tag:#project/active" --all --stdout
+```
+
+## ✨ Features
+
+- **Visual Picker:** Interactively select notes using a high-performance ANSI TUI.
+- **Vault-Aware UX:** Active vault is always visible in the TUI, with inline vault switching.
+- **Context Stitching:** Automatically bundles selected notes into a single Markdown file.
+- **LLM Ready:** Output is formatted specifically for easy consumption by AI agents.
+- **No Dependencies:** Built-in ANSI-based TUI logic (no complex visual gems required).
+- **Cross-Platform Clipboard:** Uses native clipboard commands on macOS, Windows, and Linux.
+
+## 📦 Installation
+
+### Using RubyGems
+
+```sh
+gem install architext
+architext --version
+gem uninstall architext
+```
+
+### From Source
+
+```sh
+git clone https://github.com/CanPixel/ARCHiTEXT.git
+cd ARCHiTEXT
+./bin/setup
+ruby bin/architext --version
+gem build architext.gemspec
+gem install ./architext-*.gem
+```
+
+## ⚙️ Configuration
+
+Architext relies on the [Obsidian CLI](https://github.com/obsidianmd/obsidian-cli). Ensure it is installed and available on your `PATH`.
+
+### Supported Platforms
+
+- **macOS:** Fully supported (tested in CI).
+- **Windows:** Native terminal support (PowerShell/Windows Terminal) with `clip` clipboard integration.
+- **Linux:** Native terminal support with clipboard integration via `wl-copy`, `xclip`, or `xsel`.
+
+### Setting the Obsidian CLI Path
+
+If the CLI is not in your `PATH`, you can set the `ARCHITEXT_OBSIDIAN` environment variable:
+
+```sh
+export ARCHITEXT_OBSIDIAN="/path/to/obsidian"
+```
+
+PowerShell:
+
+```powershell
+$env:ARCHITEXT_OBSIDIAN = "C:\path\to\obsidian.exe"
+```
+
+## 🛠 Usage
+
+```sh
+# Basic interactive search
+architext
+
+# Search with a specific query
+architext --query "Zombie Parkour"
+
+# Output directly to stdout (useful for piping)
+architext --query "tag:#ctx/current" --stdout | gemini "Summarize this"
+
+# Specify a vault
+architext --vault "Main Vault" --query "Ideas"
+
+# Set a persistent default vault
+architext --set-default-vault "Main Vault"
+
+# Clear the persistent default vault
+architext --clear-default-vault
+
+# Check exactly which executable version is running
+architext --version
+
+# Print vault/CLI diagnostics before searching
+architext --diagnose
+
+# Skip the picker and include all results
+architext --query "tag:#project/active" --all --stdout
+```
+
+### Vault Selection Behavior
+
+- `--vault` sets the vault only for the current run.
+- `--set-default-vault` stores a persistent default vault for future runs.
+- If `--vault` is omitted, the persistent default vault is used when available.
+- At the search prompt, type `v` to open vault configuration mode.
+- Press `v` in the TUI selection screen to change vault inline for the current session.
+- The active vault is shown in the TUI header (`vault: ...`) so target scope is always visible.
+- Vault path resolution is performed by the Obsidian CLI (`vault=<name_or_id>`); ARCHiTEXT displays the vault reference and source.
+- Startup prompt includes an Obsidian connection check (`version`, resolved vault summary, executable path).
+
+### Search Prompt Controls
+
+| Input | Action |
+| --- | --- |
+| `enter` | Run search with default query |
+| `v` | Open vault configuration screen |
+| `q` | Quit |
+
+### TUI Controls
+
+| Key | Action |
+| --- | --- |
+| `↑`/`k`, `↓`/`j` | Move selection |
+| `space` | Toggle selection for current note |
+| `a` | Toggle all visible notes |
+| `/` | Filter current results |
+| `n` | Start a new Obsidian search |
+| `v` | Set/change active vault |
+| `enter` | Confirm and bundle selected notes |
+| `q` | Return to search prompt |
+
+## 🔍 Troubleshooting
+
+### Obsidian CLI Not Found
+If you see an error about `obsidian` command not found:
+1. Ensure the Obsidian desktop app is installed.
+2. Verify that you have installed the `obsidian` CLI tool.
+3. Check if `obsidian` is in your `PATH` by running `which obsidian` (macOS/Linux) or `where obsidian` (Windows).
+4. If you previously exported `OBSCTX_OBSIDIAN`, rename it to `ARCHITEXT_OBSIDIAN`.
+
+### No Results But Notes Exist
+- Verify the active vault shown in the TUI header.
+- At the search prompt, type `v` to open vault configuration.
+- In selection, use `v` to switch vault and rerun the query.
+- Set a persistent vault with `--set-default-vault "Your Vault"`.
+- For one-off runs, pass `--vault "Your Vault"` explicitly.
+- Run `architext --diagnose` to print the exact vault reference/source and Obsidian CLI resolution before searching.
+
+### Clipboard Issues
+Architext auto-detects clipboard tools:
+- macOS: `pbcopy`
+- Windows: `clip` (fallback: PowerShell `Set-Clipboard`)
+- Linux: `wl-copy`, `xclip`, or `xsel`
+
+If none are available, run with `--stdout` and pipe output to your preferred clipboard manager.
+
+## 📜 License
+
+Architext is released under the [MIT License](LICENSE).

data/bin/architext

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/architext/cli"
+
+exit Architext::CLI.new(ARGV, app_name: "architext").run

data/bin/setup

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Removing old logs and tempfiles =="
+  # system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  # system! "bin/rails restart"
+end

data/lib/architext/bundle.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Architext
+  FileContent = Data.define(:path, :content)
+
+  class Bundle
+    def initialize(files)
+      @files = files
+    end
+
+    def to_markdown
+      sections = @files.map do |file|
+        normalized = file.content.to_s.chomp
+        "## File: #{file.path}\n\n#{normalized}"
+      end
+
+      "# Context Bundle\n\n#{sections.join("\n\n---\n\n")}\n"
+    end
+  end
+end