obfuscidian 1.0.0__tar.gz

obfuscidian-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Jeff Shurtliff
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

obfuscidian-1.0.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: obfuscidian
+Version: 1.0.0
+Summary: Obfuscate and encrypt your Obsidian vault to create secure and private backups.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Jeff Shurtliff
+Author-email: jeff@shurt.us
+Maintainer: Jeff Shurtliff
+Maintainer-email: jeff@shurt.us
+Requires-Python: >=3.12
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Environment :: Console
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: System :: Archiving :: Backup
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: click (>=8.5.0)
+Requires-Dist: cryptography (>=50.0.2)
+Requires-Dist: packaging (>=26,<27)
+Requires-Dist: urllib3 (>=2.8,<3)
+Project-URL: Changelog, https://github.com/jeffshurtliff/obfuscidian/blob/main/docs/CHANGELOG.md
+Project-URL: CI, https://github.com/jeffshurtliff/obfuscidian/actions
+Project-URL: Homepage, https://github.com/jeffshurtliff/obfuscidian
+Project-URL: Issues, https://github.com/jeffshurtliff/obfuscidian/issues
+Description-Content-Type: text/markdown
+
+
+<img src="https://raw.githubusercontent.com/jeffshurtliff/obfuscidian/1.0.0/docs/_static/obfuscidian-logo-horizontal-web.png"
+     style="max-height: 160px;"
+     alt="Obfuscidian Logo">
+
+# Obfuscidian
+
+[![Tests](https://github.com/jeffshurtliff/obfuscidian/actions/workflows/test.yml/badge.svg)](https://github.com/jeffshurtliff/obfuscidian/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/jeffshurtliff/obfuscidian/blob/main/LICENSE)
+
+Obfuscidian is a Python CLI for encrypted Obsidian vault backups. It stores
+individual Fernet-encrypted files and an encrypted path manifest in a separate
+mirror, then authenticates and restores the complete snapshot. Notes and binary
+attachments retain their exact bytes. The CLI is the supported public interface.
+
+## Version and supported environments
+
+Obfuscidian 1.0.0 is the first stable release and requires Python 3.12 or newer.
+The tested matrix covers Linux, macOS and Windows on Python 3.12–3.14.
+Linux/macOS support backup and restore writes. Native Windows supports key
+creation, verification and read-only planning; vault mutation/recovery and
+existing-log append fail closed. See [supported environments](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/PLATFORMS.md).
+
+## Install
+
+Python 3.12+ is required. For use directly from Bash, zsh or PowerShell without
+activating an environment, **pipx is recommended**. With
+[pipx installed](https://pipx.pypa.io/latest/how-to/install-pipx.html), run
+in a POSIX shell:
+
+```sh
+python3.12 --version
+pipx ensurepath
+pipx install --python python3.12 obfuscidian
+```
+
+Reopen your terminal after PATH setup, then run `obfuscidian --version` and
+`obfuscidian --help` from any folder. pipx manages an isolated Python environment
+internally; you do not activate it. See [installation](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/guides/installation.md)
+for pipx prerequisites, PowerShell commands, **pip `--user` installation outside
+a venv**, local wheels and developer setup. For unattended use, follow
+[scheduled jobs and automation](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/guides/installation.md#scheduled-jobs-and-automation).
+
+Alternatively, install into a venv:
+
+```sh
+python3 -m venv .venv
+. .venv/bin/activate
+python -m pip install obfuscidian
+obfuscidian --help
+```
+
+`python -m obfuscidian` offers the same behavior when that Python interpreter
+contains the package; your primary Python may not contain a pipx installation.
+
+## Update to a newer stable version
+
+Keep the CLI current to receive features, fixes and security patches. Update
+the installation you actually run:
+
+| Installation | Update command |
+| --- | --- |
+| pipx, originally installed from PyPI | `pipx upgrade obfuscidian` |
+| pipx, switching a source/wheel install to PyPI | `pipx runpip obfuscidian install --upgrade obfuscidian` |
+| pip user install, outside a venv | `python3 -m pip install --user --upgrade obfuscidian` |
+| Activated venv | `python -m pip install --upgrade obfuscidian` |
+
+Use the original installation's Python; in PowerShell a user install may use
+`py -3.12 -m pip install --user --upgrade obfuscidian`. Afterward, run
+`obfuscidian --version` in your usual shell and check the exact executable used
+by scheduled jobs. pipx needs no activation. A source/wheel pipx install normally
+retains its original source for `pipx upgrade`; use `runpip` again for subsequent
+PyPI updates, or follow the local-source instructions in
+[Updating Obfuscidian](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/updating.md).
+
+The CLI checks PyPI for newer stable versions and displays an advisory on stderr,
+also recording it when an optional private operational log opens. Set
+`OBFUSCIDIAN_SUPPRESS_UPDATE_NOTICE=true` or `1` to disable the request and notice.
+Checks never install updates. Subscribe to repository releases through GitHub
+**Watch → Custom → Releases** and read the [changelog](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CHANGELOG.md).
+The notice links to [update instructions](https://bit.ly/updating-obfuscidian).
+The [update guide](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/updating.md) covers all installation
+methods, failed checks and competing PATH entries.
+
+## First backup and restore
+
+New to command-line backups? Start with [What is Obfuscidian?](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/what-is-obfuscidian.md)
+and the [Quickstart](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/quickstart.md). The beginner pages introduce keys,
+backup choices and restore steps one topic at a time.
+
+Follow the [complete synthetic rehearsal](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/guides/restore-rehearsal.md)
+before using a real vault. It creates a private key outside both vaults,
+previews and writes a fresh backup, verifies every object, restores to a new
+location and compares all bytes and directories.
+
+For existing synthetic locations and their external key:
+
+```sh
+obfuscidian shroud fresh --origin ./vault --mirror ./mirror \
+  --key ./keys/obfuscidian-demo.key --non-interactive --dry-run
+obfuscidian verify --mirror ./mirror --key ./keys/obfuscidian-demo.key --non-interactive
+obfuscidian unshroud fresh --mirror ./mirror --origin ./restored \
+  --key ./keys/obfuscidian-demo.key --non-interactive --dry-run
+```
+
+The mirror must exist for verify and restore. Replace `--dry-run` with an intended
+write only after review. `--non-interactive` never supplies replacement consent;
+`--yes` does, without bypassing validation. Pause editing and sync during writes.
+
+Keep a separate offline key backup: key loss prevents decryption, with no recovery
+bypass. `shroud merge` retains deleted/renamed/excluded historical entries, so
+those notes can return on restore. Fresh replacement retains previous payloads
+outside the vault and Git; **restore rollback contains sensitive plaintext**.
+Verification and dry runs create no application files or logs. Git merge restore
+creates a separate review branch/worktree with differences left uncommitted;
+Obfuscidian never stages, commits, merges or pushes them.
+
+## Documentation
+
+- [Configuration and key custody](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CONFIGURATION.md)
+- [Fresh/additive backup](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/BACKUP.md), [verification](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/VERIFY.md) and [restore](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/RESTORE.md)
+- [Command reference](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/reference/cli.md) and [output/privacy/logging](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CLI.md)
+- [Security and limits](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/SECURITY.md), [private reporting policy](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/SECURITY.md) and [troubleshooting](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/TROUBLESHOOTING.md)
+- [Contributor guide](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/CONTRIBUTING.md) and [changelog](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CHANGELOG.md)
+
+Build the local Sphinx/reST/MyST site with the PyData theme (dark by default,
+with a reader-selectable light mode):
+
+```sh
+poetry install --with dev,docs
+poetry run sphinx-build -W --keep-going -E -a -b html docs docs/_build/html
+poetry run python .github/scripts/check_docs.py docs/_build/html
+```
+
+Open `docs/_build/html/index.html`. See [documentation maintenance](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/maintainers/documentation.md)
+for tutorial tests, rendered/accessibility review and optional external link checks.
+This build does not publish or configure hosting.
+
+## Development
+
+Use Poetry 2.2 or newer, below 3.0. Runtime dependencies have one authoritative
+list in `pyproject.toml`; `poetry.lock` records developer and optional docs tools.
+The normal pytest suite is offline and uses only synthetic temporary fixtures.
+
+```sh
+poetry install --with dev
+poetry check --lock --strict
+poetry run ruff check .
+poetry run ruff format --check .
+poetry run pytest -q
+poetry run bandit -r src/obfuscidian
+poetry build
+```
+
+Read [AGENTS.md](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/AGENTS.md) and [CONTRIBUTING.md](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/CONTRIBUTING.md) before changing
+code. Keep work within the requested task and leave changes reviewable.
+Git history and publication actions require separate maintainer authorization.
+The project is licensed under [Apache-2.0](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/LICENSE).
+
+---
+
+_This utility is considered unofficial and is in no way endorsed or supported by [Obsidian](https://obsidian.md/terms)._
+

obfuscidian-1.0.0/README.md

@@ -0,0 +1,162 @@
+
+<img src="https://raw.githubusercontent.com/jeffshurtliff/obfuscidian/1.0.0/docs/_static/obfuscidian-logo-horizontal-web.png"
+     style="max-height: 160px;"
+     alt="Obfuscidian Logo">
+
+# Obfuscidian
+
+[![Tests](https://github.com/jeffshurtliff/obfuscidian/actions/workflows/test.yml/badge.svg)](https://github.com/jeffshurtliff/obfuscidian/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/jeffshurtliff/obfuscidian/blob/main/LICENSE)
+
+Obfuscidian is a Python CLI for encrypted Obsidian vault backups. It stores
+individual Fernet-encrypted files and an encrypted path manifest in a separate
+mirror, then authenticates and restores the complete snapshot. Notes and binary
+attachments retain their exact bytes. The CLI is the supported public interface.
+
+## Version and supported environments
+
+Obfuscidian 1.0.0 is the first stable release and requires Python 3.12 or newer.
+The tested matrix covers Linux, macOS and Windows on Python 3.12–3.14.
+Linux/macOS support backup and restore writes. Native Windows supports key
+creation, verification and read-only planning; vault mutation/recovery and
+existing-log append fail closed. See [supported environments](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/PLATFORMS.md).
+
+## Install
+
+Python 3.12+ is required. For use directly from Bash, zsh or PowerShell without
+activating an environment, **pipx is recommended**. With
+[pipx installed](https://pipx.pypa.io/latest/how-to/install-pipx.html), run
+in a POSIX shell:
+
+```sh
+python3.12 --version
+pipx ensurepath
+pipx install --python python3.12 obfuscidian
+```
+
+Reopen your terminal after PATH setup, then run `obfuscidian --version` and
+`obfuscidian --help` from any folder. pipx manages an isolated Python environment
+internally; you do not activate it. See [installation](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/guides/installation.md)
+for pipx prerequisites, PowerShell commands, **pip `--user` installation outside
+a venv**, local wheels and developer setup. For unattended use, follow
+[scheduled jobs and automation](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/guides/installation.md#scheduled-jobs-and-automation).
+
+Alternatively, install into a venv:
+
+```sh
+python3 -m venv .venv
+. .venv/bin/activate
+python -m pip install obfuscidian
+obfuscidian --help
+```
+
+`python -m obfuscidian` offers the same behavior when that Python interpreter
+contains the package; your primary Python may not contain a pipx installation.
+
+## Update to a newer stable version
+
+Keep the CLI current to receive features, fixes and security patches. Update
+the installation you actually run:
+
+| Installation | Update command |
+| --- | --- |
+| pipx, originally installed from PyPI | `pipx upgrade obfuscidian` |
+| pipx, switching a source/wheel install to PyPI | `pipx runpip obfuscidian install --upgrade obfuscidian` |
+| pip user install, outside a venv | `python3 -m pip install --user --upgrade obfuscidian` |
+| Activated venv | `python -m pip install --upgrade obfuscidian` |
+
+Use the original installation's Python; in PowerShell a user install may use
+`py -3.12 -m pip install --user --upgrade obfuscidian`. Afterward, run
+`obfuscidian --version` in your usual shell and check the exact executable used
+by scheduled jobs. pipx needs no activation. A source/wheel pipx install normally
+retains its original source for `pipx upgrade`; use `runpip` again for subsequent
+PyPI updates, or follow the local-source instructions in
+[Updating Obfuscidian](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/updating.md).
+
+The CLI checks PyPI for newer stable versions and displays an advisory on stderr,
+also recording it when an optional private operational log opens. Set
+`OBFUSCIDIAN_SUPPRESS_UPDATE_NOTICE=true` or `1` to disable the request and notice.
+Checks never install updates. Subscribe to repository releases through GitHub
+**Watch → Custom → Releases** and read the [changelog](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CHANGELOG.md).
+The notice links to [update instructions](https://bit.ly/updating-obfuscidian).
+The [update guide](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/updating.md) covers all installation
+methods, failed checks and competing PATH entries.
+
+## First backup and restore
+
+New to command-line backups? Start with [What is Obfuscidian?](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/what-is-obfuscidian.md)
+and the [Quickstart](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/getting-started/quickstart.md). The beginner pages introduce keys,
+backup choices and restore steps one topic at a time.
+
+Follow the [complete synthetic rehearsal](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/guides/restore-rehearsal.md)
+before using a real vault. It creates a private key outside both vaults,
+previews and writes a fresh backup, verifies every object, restores to a new
+location and compares all bytes and directories.
+
+For existing synthetic locations and their external key:
+
+```sh
+obfuscidian shroud fresh --origin ./vault --mirror ./mirror \
+  --key ./keys/obfuscidian-demo.key --non-interactive --dry-run
+obfuscidian verify --mirror ./mirror --key ./keys/obfuscidian-demo.key --non-interactive
+obfuscidian unshroud fresh --mirror ./mirror --origin ./restored \
+  --key ./keys/obfuscidian-demo.key --non-interactive --dry-run
+```
+
+The mirror must exist for verify and restore. Replace `--dry-run` with an intended
+write only after review. `--non-interactive` never supplies replacement consent;
+`--yes` does, without bypassing validation. Pause editing and sync during writes.
+
+Keep a separate offline key backup: key loss prevents decryption, with no recovery
+bypass. `shroud merge` retains deleted/renamed/excluded historical entries, so
+those notes can return on restore. Fresh replacement retains previous payloads
+outside the vault and Git; **restore rollback contains sensitive plaintext**.
+Verification and dry runs create no application files or logs. Git merge restore
+creates a separate review branch/worktree with differences left uncommitted;
+Obfuscidian never stages, commits, merges or pushes them.
+
+## Documentation
+
+- [Configuration and key custody](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CONFIGURATION.md)
+- [Fresh/additive backup](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/BACKUP.md), [verification](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/VERIFY.md) and [restore](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/RESTORE.md)
+- [Command reference](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/reference/cli.md) and [output/privacy/logging](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CLI.md)
+- [Security and limits](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/SECURITY.md), [private reporting policy](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/SECURITY.md) and [troubleshooting](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/TROUBLESHOOTING.md)
+- [Contributor guide](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/CONTRIBUTING.md) and [changelog](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/CHANGELOG.md)
+
+Build the local Sphinx/reST/MyST site with the PyData theme (dark by default,
+with a reader-selectable light mode):
+
+```sh
+poetry install --with dev,docs
+poetry run sphinx-build -W --keep-going -E -a -b html docs docs/_build/html
+poetry run python .github/scripts/check_docs.py docs/_build/html
+```
+
+Open `docs/_build/html/index.html`. See [documentation maintenance](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/docs/maintainers/documentation.md)
+for tutorial tests, rendered/accessibility review and optional external link checks.
+This build does not publish or configure hosting.
+
+## Development
+
+Use Poetry 2.2 or newer, below 3.0. Runtime dependencies have one authoritative
+list in `pyproject.toml`; `poetry.lock` records developer and optional docs tools.
+The normal pytest suite is offline and uses only synthetic temporary fixtures.
+
+```sh
+poetry install --with dev
+poetry check --lock --strict
+poetry run ruff check .
+poetry run ruff format --check .
+poetry run pytest -q
+poetry run bandit -r src/obfuscidian
+poetry build
+```
+
+Read [AGENTS.md](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/AGENTS.md) and [CONTRIBUTING.md](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/CONTRIBUTING.md) before changing
+code. Keep work within the requested task and leave changes reviewable.
+Git history and publication actions require separate maintainer authorization.
+The project is licensed under [Apache-2.0](https://github.com/jeffshurtliff/obfuscidian/blob/1.0.0/LICENSE).
+
+---
+
+_This utility is considered unofficial and is in no way endorsed or supported by [Obsidian](https://obsidian.md/terms)._

obfuscidian-1.0.0/SECURITY.md

@@ -0,0 +1,21 @@
+# Security policy
+
+Report suspected vulnerabilities in Obfuscidian 1.0.0 and the current source
+privately. No fixed support window, independent security certification or
+guaranteed recovery is claimed. Include the affected version in your report.
+
+Use the repository's GitHub **Security → Report a vulnerability** action if
+private reporting is enabled; its availability is not assumed. If unavailable,
+contact the maintainer privately at **jeff@shurt.us**, the public maintainer
+address in `pyproject.toml`. Start with a sanitized summary and agree on a secure
+channel before sharing sensitive details. No response deadline is promised.
+
+Never send real keys, credentials or vault data. Do not publish exploit payloads,
+detailed attack instructions, sensitive environment information or identifying
+local paths in issues. Public security issue templates are for sanitized,
+non-sensitive hardening tracking only. Coordinate sensitive findings privately;
+do not copy private details into public discussion.
+
+For the threat model, key custody, resource limits and recovery boundaries, see
+[the security guide](docs/SECURITY.md). Contributor handling is governed by
+[CONTRIBUTING.md](CONTRIBUTING.md) and [AGENTS.md](AGENTS.md).