Compare commits

..
2 Commits
Author SHA1 Message Date
ksmithandClaude Sonnet 5 997e2fb976 Mark all milestones complete; remove obsolete bootstrap-prompt docs
All planned milestones (M0-M10) are done -- PROGRESS.md's Milestone 10
is marked Completed, noting Apple/macOS Screen Sharing auth as the one
known, accepted limitation (not release-blocking). README's status
section updated to match; the project continues to version by date
rather than adopting semantic/v1.0-style versioning.

Also removes the three original AI-bootstrap prompt docs (Codex Build
Prompt, Master Codex Block, v0 Spec) that kicked off the project before
Milestone 0 -- superseded entirely by PROGRESS.md's actual history, and
referenced nowhere else in the repo.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-28 16:56:59 -06:00
ksmithandClaude Sonnet 5 e6023a884f Update README.md for Quick Connect, RDP clipboard sync, latest release
README.md hadn't been touched since v2026.9.16.7 and had drifted:
Quick Connect (issue #23) was undocumented, RDP's own clipboard sync
was missing from its feature list (only VNC's was listed), and the
"latest release" pointed at a stale version with a note about a draft
that has long since published.

Also adds CLAUDE.md with a release checklist so README.md gets checked
for drift as a standard part of every release going forward, per user
request, instead of falling behind until someone notices.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-28 16:53:04 -06:00
6 changed files with 45 additions and 210 deletions

No files matched your search

+20
View File
@@ -0,0 +1,20 @@
# OrbitHub
## Release checklist
Every release (new tag + build + publish) must include:
- **Update `README.md`** to match current reality before tagging:
latest published release version/link, the Implemented Features list
(add/adjust bullets for anything shipped since the last release), and
any status notes (e.g. VNC/Apple-auth caveats) that changed.
- Update `docs/PROGRESS.md` with a bullet describing what shipped.
- Bump the version in `CMakeLists.txt`.
- Build and test all reachable platforms (Linux local, Windows and macOS
over SSH — see prior release commits/sessions for the build scripts
used) before publishing.
`docs/USER_GUIDE.md` (in-app `Help -> User Guide` and the release PDF)
should also be checked for drift when a change affects user-facing
behavior, though it doesn't need a pass on every single release the way
README.md does.
+12 -7
View File
@@ -11,13 +11,12 @@ Supported target platforms:
## Current Status
OrbitHub is in active development.
OrbitHub is in active development, with all planned milestones (M0-M10)
complete.
- Milestones completed: M0-M9
- Current milestone: Milestone 10 (v1.0 Stabilization)
- Latest published release: `v2026.9.16`; a `v2026.9.16.6` release is
drafted with several post-`.16` fixes and is pending a macOS installer
before publishing
- Latest published release: `v2026.9.28`
- Versioned by date rather than semantic/`v1.0`-style versioning; see
[docs/PROGRESS.md](docs/PROGRESS.md) for the full release history
- VNC (M6) is fully built out: Raw/CopyRect/Hextile/ZRLE/Tight encodings,
bidirectional clipboard sync, remote cursor shape sync, and both
scale-to-fit and actual-size display modes. Standard VNC Authentication
@@ -31,7 +30,7 @@ Progress and milestone details:
- [docs/PROGRESS.md](docs/PROGRESS.md)
Latest published release (installers for Windows, Linux, and macOS):
- [v2026.9.16](https://git.darksingularity.org/DarkSingularity/orbithub/releases/tag/v2026.9.16)
- [v2026.9.28](https://git.darksingularity.org/DarkSingularity/orbithub/releases/tag/v2026.9.28)
User Guide:
- [docs/USER_GUIDE.md](docs/USER_GUIDE.md) (also available as a PDF attached to each release, and in-app via `Help -> User Guide`)
@@ -69,6 +68,10 @@ An embedded RDP session in a tab.
- Drag-and-drop profile moves between folders with persistence
- Import/Export of the whole profile list as JSON, and one-way import from
mRemoteNG connection XML files (passwords are never imported)
- Quick Connect: open a session without saving a profile first (`File`
menu or a button on the Profiles tab); a "Save as Profile..." action on
the resulting tab persists it afterward, pre-filled with what was
entered
### Session Experience
@@ -97,6 +100,7 @@ An embedded RDP session in a tab.
- Resize handling and resolution renegotiation
- Domain-aware authentication support
- RDP security/performance profile options
- Bidirectional clipboard sync
### VNC
@@ -122,6 +126,7 @@ An embedded RDP session in a tab.
- `File` menu:
- New Profile
- New Folder
- Quick Connect...
- Import Profiles...
- Export Profiles...
- Import from mRemoteNG...
@@ -1,36 +0,0 @@
# OrbitHub Codex Build Prompt (Pure C++ / Qt6 Widgets)
You are Codex. You will implement OrbitHub entirely in C++ using Qt6 Widgets.
The previous Python/Shiboken implementation is abandoned.
## Rules
- Use modern CMake
- Use Qt6 Widgets only
- Use C++17 or newer
- Never block the GUI thread
- Use Git for checkpointing
- Maintain docs/PROGRESS.md
## Required Git Workflow
Create milestone branches:
- milestone-0-restart-cpp
- milestone-1-storage
Make small logical commits.
Tag milestone completions:
- v0-m0-done
- v0-m1-done
## Milestone 0 Deliverable
Implement:
- ProfilesWindow (QMainWindow)
- SessionWindow (QMainWindow)
- QTabWidget hosting placeholder QWidget
- main.cpp wiring
Stop after Milestone 0 is complete and tagged.
@@ -1,10 +0,0 @@
You are Codex and you will do ALL implementation work for OrbitHub.
1) Read docs/OrbitHub_v0_Spec_CPP_QtWidgets.md
2) Read docs/OrbitHub_Codex_Build_Prompt_CPP_QtWidgets.md
Follow the Build Prompt strictly.
Use Git branches, commits, and tags.
Update docs/PROGRESS.md.
Stop after Milestone 0 and tag v0-m0-done.
-152
View File
@@ -1,152 +0,0 @@
# OrbitHub v0 Specification (Pure C++ / Qt6 Widgets)
## Overview
OrbitHub is a cross-platform native desktop application for managing and launching remote sessions.
Platforms:
- Windows 11
- Linux (Mint/Ubuntu-family)
- macOS
Implementation:
- 100% C++
- Qt 6 Widgets (no Qt Quick)
- CMake build system
- MIT License
This replaces the earlier Python-based architecture.
---
## UX Model
OrbitHub uses a two-window model:
1) Profiles Window (single instance)
- List of saved profiles
- Search box
- New / Edit / Delete
- Double-click connects
2) Session Window(s)
- QTabWidget
- One tab per session
- Close tab destroys session
- Placeholder view widget displays:
"OrbitHub Native Surface"
---
## Milestone 0
- Fresh C++/Qt repo scaffold
- App builds
- Profiles window launches
- Session window opens with placeholder tab
- Tag: v0-m0-done
---
## Milestone 1
- SQLite integration
- Profiles CRUD
- Connect loads profile name into tab
- Tag: v0-m1-done
---
## Milestone 2
- Extend profiles schema (`host`, `port`, `username`, `protocol`, `auth_mode`)
- Replace prompt-based create/edit with a structured profile dialog form
- Connect loads full profile details into session tab
- Session lifecycle states in UI (`Connecting`, `Connected`, `Failed`) with non-blocking updates
- Tag: v0-m2-done
---
## Milestone 3
- Real SSH backend using native `ssh` process (connect, disconnect, reconnect)
- Protocol backend abstraction with worker-thread execution
- RDP/VNC explicitly marked as not implemented in session UX
- Connect-time credential prompts (password/private key path) with no secret storage in DB
- Session tab controls: `Connect`, `Disconnect`, `Reconnect`, `Copy Error`
- Per-session timestamped event log and user-friendly error mapping
- Profile schema extended with `private_key_path` and `known_hosts_policy`
- Tag: v0-m3-done
---
## Milestone 4
- Interactive embedded SSH terminal (`KodoTerm` + `libvterm`)
- SSH host-key trust prompt flow for `Ask` policy
- Improved SSH auth flow for password / private key
- Terminal utilities and UX polish (theme, clear, resize/input behavior)
- Session lifecycle UX cleanup (auto-connect, disconnect on close, tab state indicators)
- Tag: v0-m4-done
---
## Milestone 5 - RDP Fully Working
- Implement complete RDP protocol support (replace not-implemented RDP path)
- Deliver a usable in-app RDP session experience consistent with SSH tab UX
- Support RDP connect/disconnect/reconnect lifecycle from OrbitHub
- Add required RDP-specific connect options in profile/session flows
- Normalize event/error reporting with existing SSH behavior
- Planned Tag: v0-m5-done
---
## Milestone 6 - VNC Fully Working
- Implement complete VNC protocol support (replace not-implemented VNC path)
- Deliver a usable in-app VNC session experience consistent with SSH/RDP tab UX
- Support VNC connect/disconnect/reconnect lifecycle from OrbitHub
- Add required VNC-specific connect options in profile/session flows
- Normalize event/error reporting with SSH/RDP behavior
- Planned Tag: v0-m6-done
---
## Milestone 7 - Cross-Platform Protocol Hardening
- Validate SSH/RDP/VNC behavior on Windows, Linux, and macOS
- Resolve platform-specific path/process/auth differences
- Improve diagnostics and failure messaging for common protocol issues
- Add protocol regression checklist and repeatable verification scripts
- Planned Tag: v0-m7-done
---
## Milestone 8 - Profile and Session UX Completion
- Complete profile fields/validation for all protocols
- Add quality-of-life controls for active sessions (tab context actions, defaults, persistence)
- Persist per-user UI/session preferences (theme, panel visibility, terminal defaults)
- Improve session history/event visibility and filtering
- Planned Tag: v0-m8-done
---
## Milestone 9 - Packaging and Distribution
- Produce distributable artifacts for Windows, Linux, and macOS
- Document dependency/runtime requirements per platform
- Add release build scripts for reproducible packaging
- Validate clean install + first-run flow on each platform
- Planned Tag: v0-m9-done
---
## Milestone 10 - v1.0 Stabilization
- End-to-end QA pass across core workflows (profile CRUD + SSH/RDP/VNC session lifecycle)
- Fix blocker/critical defects from validation
- Finalize docs (`BUILDING`, usage notes, known limitations)
- Prepare v1.0 release notes and final acceptance checklist
- Planned Tag: v1.0.0
+13 -5
View File
@@ -443,9 +443,17 @@ Git:
## Milestone 10 - v1.0 Stabilization
Status: Planned
Status: Completed
Planned Scope:
- Run final regression and acceptance testing across all protocols
- Resolve release-blocking defects
- Finalize docs and publish v1.0 release notes/checklist
All planned milestones (M0-M10) are now complete. OrbitHub has shipped a
long series of dated releases (see the release list under Milestone 9,
plus everything since) covering SSH, RDP, and VNC end to end, profile
management (folders/tags/search/Import-Export/Quick Connect), and
packaging for all three platforms. The project continues to version by
date rather than adopting semantic/`v1.0`-style versioning.
Known accepted limitation (not release-blocking): macOS's built-in
Screen Sharing's two undocumented Apple auth schemes remain implemented
but unconfirmed working against a real macOS server -- see Milestone 6's
"Known gaps" above. Every other protocol/server combination in scope
works end to end.