@thingd/cli 0.31.0

package/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 [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,238 @@
+# thingd-cli
+
+[![npm downloads (CLI)](https://img.shields.io/npm/dm/thingd-cli?label=downloads&logo=npm&color=ff6a00)](https://www.npmjs.com/package/thingd-cli)
+[![npm version (CLI)](https://img.shields.io/npm/v/thingd-cli?label=version&logo=npm&color=ff6a00)](https://www.npmjs.com/package/thingd-cli)
+
+A fast object-first data engine for applications and AI agents.
+
+This is the **thingd** CLI — command-line interface, Interactive TUI Dashboard, and MCP server for [thingd](https://www.npmjs.com/package/thingd). It provides the unified `thingd` binary, serving as a persistent stdio/HTTP MCP server for editors (Cursor, Claude Desktop), an interactive terminal UI dashboard for database operations, and a scriptable JSON utility to inspect and manage local or remote thingd databases.
+
+## Installation
+
+### npm (CLI)
+
+Install globally via npm to use the `thingd` command anywhere:
+
+```bash
+npm install -g thingd-cli
+```
+
+Or run it on the fly using `npx`:
+
+```bash
+npx thingd-cli
+```
+
+### Docker (sidecar runtime)
+
+```bash
+docker pull sayanmohsin/thingd
+docker run -p 8757:8757 sayanmohsin/thingd
+```
+
+See the [Docker Hub](https://hub.docker.com/r/sayanmohsin/thingd) page for all tags.
+
+## Quick Start: Zero-Config MCP Setup
+
+The easiest way to integrate `thingd` with your editors (Claude Desktop and Cursor) is to run the automated setup command:
+
+```bash
+thingd install
+```
+
+This command will:
+- Auto-detect the absolute path of your active `node` binary and global `thingd` script.
+- Automatically locate or create your persistent local database at `~/.thingd/data.db`.
+- **For Claude Desktop**: Automatically configure the stdio MCP server in your `claude_desktop_config.json` (macOS).
+- **For Cursor**: Print the exact, copy-pasteable JSON block to paste into your Cursor MCP settings.
+
+## Two Modes of Operation
+
+The CLI is designed to support both human operators and automated scripts through two distinct modes:
+
+1. **Interactive Dashboard (TUI)**: Run `thingd` without any arguments to launch a beautiful, interactive terminal UI. Perfect for exploring collections, editing objects, and managing queues manually.
+2. **Non-Interactive CLI**: Run `thingd <command>` for one-off operations. This mode intentionally emits JSON so it is easy to use from shell scripts, CI/CD pipelines, and automated workflows.
+
+---
+
+## 1. Interactive Dashboard (TUI)
+
+To start the interactive dashboard, simply run:
+```bash
+thingd
+```
+
+### Connection Mode
+Upon launch, you will be prompted to select a connection driver:
+- `Memory`: An ephemeral, in-memory instance (great for quick testing).
+- `Native`: Connects directly to a local SQLite `.db` file (requires a file path).
+- `Cloud`: Connects to a remote ThingD cluster (requires a URL and an optional Bearer Token).
+
+### Keyboard Shortcuts
+Once connected, the TUI provides a dual-pane layout: a navigation sidebar on the left and a detailed viewer/editor on the right.
+
+| Shortcut | Action |
+|----------|--------|
+| `↑` / `↓` (or `k` / `j`) | Navigate the tree vertically |
+| `←` / `→` (or `h` / `l`) | Expand or collapse folders (Collections, Streams, Queues) |
+| `Enter` | Expand node or open a folder |
+| `c` | **Create** a new Object, Event, or push a Queue job |
+| `e` | **Edit** an Object or retry a Queue job |
+| `d` | **Delete** an Object or Ack/Resolve a Queue job |
+| `/` (or `f`) | **Global Semantic Search** across the database |
+| `i` | **Info**: View Connection Info & Cloud Cluster Status |
+| `r` | **Refresh** data from the database |
+| `s` | **Switch** database connections |
+| `q` | **Quit** |
+
+---
+
+## 2. Non-Interactive CLI
+
+For scripts and automation, you can bypass the TUI entirely. 
+
+### Common Options
+You can configure the connection via environment variables or CLI flags:
+
+```txt
+--url <url>          remote thingd URL. Defaults to THINGD_URL
+--auth-token <tok>   remote bearer token. Defaults to THINGD_AUTH_TOKEN
+--path <path>        local database path. Defaults to THINGD_PATH or ~/.thingd/data.db
+--driver <driver>    memory, native, or cloud
+--pretty             pretty-print JSON output
+--limit <n>          result limit for search and list commands
+```
+
+### Native Driver (SQLite)
+
+Use the native SQLite driver for persistent local storage:
+
+```bash
+thingd --path ./my-data.db --driver native
+```
+
+Or set environment variables:
+
+```bash
+export THINGD_PATH=./app-data.db
+export THINGD_DRIVER=native
+thingd
+```
+
+All commands work identically — objects, events, queues, and search are all persisted.
+
+### MCP Server
+
+Run a persistent Streamable HTTP MCP server for remote agents:
+
+```bash
+thingd mcp-http --path ./data.db --driver native --auth-token my-token
+```
+
+Connect via MCP stdio for Claude Desktop and Cursor:
+
+```bash
+thingd mcp --path ./data.db --driver native
+```
+
+### MCP Integration
+
+The `thingd` CLI has a built-in `mcp` subcommand that exposes an MCP server over `stdio`. This allows Claude Desktop to securely connect to your `thingd` database.
+
+**Connecting to a Local Database:**
+To let Claude read and write to a local `thingd.db` file, add this to your `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "thingd-local": {
+      "command": "thingd",
+      "args": ["mcp", "--path", "/absolute/path/to/thingd.db", "--driver", "native"]
+    }
+  }
+}
+```
+
+**Bridging Claude to the Cloud:**
+Claude Desktop natively only supports local `stdio` servers. However, `thingd mcp` can act as a bridge! If you provide a `--url`, the CLI will launch locally but seamlessly proxy all of Claude's requests to your remote cluster:
+
+```json
+{
+  "mcpServers": {
+    "thingd-cloud": {
+      "command": "thingd",
+      "args": ["mcp", "--url", "https://your-thingd-cloud.com/mcp", "--auth-token", "your-secret-token"]
+    }
+  }
+}
+```
+
+**Running as a Streamable HTTP Server:**
+If you want to run `thingd` as a standalone Streamable HTTP MCP server (for example, to connect remote agents or ChatGPT), you can spin it up directly using `mcp-http`:
+
+```bash
+thingd mcp-http --path ./thingd.db --driver native --port 8757 --auth-token change-me
+```
+
+### Command Reference
+
+**System & Diagnostics**
+```bash
+thingd doctor                 # Run Node, native binding, and remote connectivity diagnostics
+thingd metrics                # Get total database counts (objects, events, activeJobs, deadJobs)
+thingd status                 # Check cluster health (requires --url)
+thingd tools                  # List available MCP tools (requires --url)
+thingd bench rust --smoke     # Run Rust SQLite engine smoke benchmarks
+thingd bench rust --count 500 # Run Rust SQLite engine benchmarks with specific run count
+```
+
+**Discovery & Collections**
+```bash
+thingd collections list       # List all active collections
+thingd streams list           # List all active stream names (alias for events streams)
+thingd events streams         # List all active event streams
+thingd queues list-all        # List all active queue names
+```
+
+**Search**
+```bash
+thingd search "my query" [--collection <name>] [--limit <n>]
+```
+
+**Objects**
+```bash
+thingd objects list decisions                  # List all objects inside a collection
+thingd objects put decisions core --text "msg" # Put object with plain text content
+thingd objects put decisions core --data '{"a":1}' # Put object with arbitrary JSON data
+thingd objects get decisions core              # Fetch a specific object by ID
+thingd objects delete decisions core           # Delete an object by ID
+```
+
+**Events**
+```bash
+thingd events append project:thingd decision.made --text "Picked the CLI shape."
+thingd events list project:thingd
+```
+
+**Queues**
+```bash
+thingd queues stats embed                      # View queue statistics (ready, leased, dead jobs)
+thingd queues push embed --payload '{"object":"docs/readme"}'
+thingd queues claim embed
+thingd queues ack embed <jobId>
+thingd queues nack embed <jobId> --error "failed to fetch" --delay-ms 5000
+thingd queues list embed
+thingd queues dead embed
+```
+
+**Data Movement & Snapshots**
+```bash
+# Export & Import Data with optional recursive secret/email/key redaction
+thingd export --collection decisions --out decisions.jsonl [--redact]
+thingd export --events [--stream name] --out events.jsonl [--redact custom_secret]
+thingd import --collection decisions_restored --in decisions.jsonl
+
+# Snapshot & Restore full database state
+thingd snapshot create --out snapshot.thingd.json
+thingd snapshot restore --in snapshot.thingd.json
+```