wondersearch-cli 0.1.0__tar.gz

wondersearch_cli-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+.venv*/
+dist/
+__pycache__/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.egg-info/
+.env
+.env.*
+*.env
+*.env.*
+TODO
+TODO.*
+todos/

wondersearch_cli-0.1.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+- Return and save the final document ID after upload, replacement, and resume processing completes.
+- Withhold document import and source download from the launch CLI.
+- Return document delete/replace receipts immediately; follow processing with operation status.
+- Reject unsupported options and show action-specific help.
+- Report usage scope explicitly; only `usage --workspace UUID` filters workspace usage.
+- Reject unknown profile switches, explain environment overrides, and label saved configuration.
+
+### Earlier preview changes
+
+- Remove `passage get` from the CLI; use passage text and source details returned by search for citations.
+- Remove `search --limit`; list-command pagination limits remain supported.
+- Remove the ineffective `auth_kind` configuration key; authentication follows the actual credential.
+
+- Honor `drive create --wait` and its provisioning timeout, retaining the created drive ID on wait failure.
+- Apply `document import --folder` to every record, including explicit root selection.
+- Send a distinct root-only filter for `search --folder root`.
+- Reject `drive delete --all` before configuration or API access; retain `drive list --all` pagination.
+- Open browser sign-in with `wondersearch login`; keep API-key and explicit access-token login.
+- Default to the production API without an initial configuration command.
+- Store browser sessions in the operating system credential store and renew them automatically.
+- Revoke the CLI session on logout without signing out the browser.
+- Support a printed sign-in URL with `--no-browser` on the same computer.
+
+
+- Use the operator-selected model for search, without a model-selection option. The current API ignores the legacy model selector sent by this release.
+- Support document grouping and server deadlines.
+- Document the fixed ten-result search limit.
+- Remove the workspace capabilities command from the initial release.
+- Initial command-line client, private profiles, existing-session and API-key login.
+- Recursive folder uploads, recoverable transfers, status polling and search.
+- Server-enforced permissions, canonical errors, independent CLI compatibility notices.
+- Standalone distribution CI and controlled publication workflows.
+- Reject oversized structured-import records before submitting any batches.
+- Limit search effort choices to the supported small, medium, and large levels.
+- Return structured errors for malformed API/recovery data and cancelled terminal input.
+- Expand command-level success, failure, retry, and recovery coverage.

wondersearch_cli-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

wondersearch_cli-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: wondersearch-cli
+Version: 0.1.0
+Summary: Command-line client for WonderSearch
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: keyring<26,>=25
+Requires-Dist: packaging<27,>=24
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == 'dev'
+Requires-Dist: hatchling<2,>=1.26; extra == 'dev'
+Requires-Dist: mypy<2,>=1.15; extra == 'dev'
+Requires-Dist: pytest<10,>=8; extra == 'dev'
+Requires-Dist: ruff<1,>=0.11; extra == 'dev'
+Requires-Dist: twine<7,>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# WonderSearch CLI
+
+Upload your documents and search them from the terminal.
+
+## Install
+
+Requires Python 3.10–3.14 on macOS, Windows, or Linux.
+
+From a local copy of this repository, install the CLI:
+
+```sh
+python -m pip install .
+```
+
+## Sign in
+
+Set up your WonderSearch account in the Console, then run:
+
+```sh
+wondersearch login
+```
+
+Your browser will open. Check that the verification code matches the one in your
+terminal, then sign in and choose **Connect CLI**. If you are already signed in,
+you can connect that account directly.
+
+If the browser does not open, run `wondersearch login --no-browser` and open the
+printed link on the same computer.
+
+## Choose where to work
+
+List your workspaces and drives, then select the ones you want to use:
+
+```sh
+wondersearch workspace list
+wondersearch workspace use WORKSPACE_ID
+wondersearch drive list
+wondersearch drive use DRIVE_ID
+```
+
+Replace `WORKSPACE_ID` and `DRIVE_ID` with IDs from the lists. The CLI remembers
+your selections for later commands.
+
+## Upload documents
+
+Upload a file:
+
+```sh
+wondersearch upload ./guide.pdf --wait
+```
+
+Or upload a folder and its contents:
+
+```sh
+wondersearch upload ./docs --recursive --wait
+```
+
+Supported formats are PDF, Word (.docx), plain text, and Markdown. `--wait` keeps
+the command running until your documents are ready to search.
+
+To preview a folder upload without sending files:
+
+```sh
+wondersearch upload ./docs --recursive --dry-run
+```
+
+The service operator selects the search model; there is no CLI model-selection
+option. The response's `model` field identifies the model actually used. The server
+enforces the active model's token limit and the 16,384 UTF-8 byte limit.
+Search returns at most 10 results; `search --limit` is not supported.
+Use `--no-group-by-document` to allow multiple
+passages per document, or `--group-by-document` to group them. `--timeout-ms`
+sets a server deadline from 1 to 20,000 milliseconds; omission uses the effort
+default configured by the server. This deadline is distinct from upload and
+processing timeouts.
+
+Uploading the same file again creates another document. To update an existing
+document, use `wondersearch upload ./guide.pdf --replace DOCUMENT_ID --wait`.
+
+If an upload is interrupted, use the run ID printed in the terminal to resume it:
+
+```sh
+wondersearch upload resume RUN_ID --wait
+```
+
+## Search
+
+Ask a question about the documents in your selected drive:
+
+```sh
+wondersearch search "How do I reset my password?"
+```
+
+To search a specific folder, add `--folder FOLDER_ID`.
+
+## Other useful commands
+
+| Task | Command |
+| --- | --- |
+| Check which account is signed in | `wondersearch whoami` |
+| List documents | `wondersearch document list` |
+| List folders | `wondersearch folder list` |
+| Create a folder | `wondersearch folder create "Research"` |
+| Check account usage | `wondersearch usage` |
+| Check storage | `wondersearch storage` |
+| Sign out of the CLI | `wondersearch logout` |
+
+Signing out of the CLI leaves you signed in to the Console.
+
+## Use in scripts
+
+Add `--json` to a command for output your script can read:
+
+```sh
+wondersearch search "What is our refund policy?" --json
+```
+
+For automation, sign in with an API key using `wondersearch login --api-key`.
+Paste the key at the hidden prompt. API keys can only access the workspace and
+actions they have permission to use.
+
+## Get help
+
+Use `--help` to see the available commands and options:
+
+```sh
+wondersearch --help
+wondersearch upload --help
+wondersearch search --help
+```

wondersearch_cli-0.1.0/README.md

@@ -0,0 +1,130 @@
+# WonderSearch CLI
+
+Upload your documents and search them from the terminal.
+
+## Install
+
+Requires Python 3.10–3.14 on macOS, Windows, or Linux.
+
+From a local copy of this repository, install the CLI:
+
+```sh
+python -m pip install .
+```
+
+## Sign in
+
+Set up your WonderSearch account in the Console, then run:
+
+```sh
+wondersearch login
+```
+
+Your browser will open. Check that the verification code matches the one in your
+terminal, then sign in and choose **Connect CLI**. If you are already signed in,
+you can connect that account directly.
+
+If the browser does not open, run `wondersearch login --no-browser` and open the
+printed link on the same computer.
+
+## Choose where to work
+
+List your workspaces and drives, then select the ones you want to use:
+
+```sh
+wondersearch workspace list
+wondersearch workspace use WORKSPACE_ID
+wondersearch drive list
+wondersearch drive use DRIVE_ID
+```
+
+Replace `WORKSPACE_ID` and `DRIVE_ID` with IDs from the lists. The CLI remembers
+your selections for later commands.
+
+## Upload documents
+
+Upload a file:
+
+```sh
+wondersearch upload ./guide.pdf --wait
+```
+
+Or upload a folder and its contents:
+
+```sh
+wondersearch upload ./docs --recursive --wait
+```
+
+Supported formats are PDF, Word (.docx), plain text, and Markdown. `--wait` keeps
+the command running until your documents are ready to search.
+
+To preview a folder upload without sending files:
+
+```sh
+wondersearch upload ./docs --recursive --dry-run
+```
+
+The service operator selects the search model; there is no CLI model-selection
+option. The response's `model` field identifies the model actually used. The server
+enforces the active model's token limit and the 16,384 UTF-8 byte limit.
+Search returns at most 10 results; `search --limit` is not supported.
+Use `--no-group-by-document` to allow multiple
+passages per document, or `--group-by-document` to group them. `--timeout-ms`
+sets a server deadline from 1 to 20,000 milliseconds; omission uses the effort
+default configured by the server. This deadline is distinct from upload and
+processing timeouts.
+
+Uploading the same file again creates another document. To update an existing
+document, use `wondersearch upload ./guide.pdf --replace DOCUMENT_ID --wait`.
+
+If an upload is interrupted, use the run ID printed in the terminal to resume it:
+
+```sh
+wondersearch upload resume RUN_ID --wait
+```
+
+## Search
+
+Ask a question about the documents in your selected drive:
+
+```sh
+wondersearch search "How do I reset my password?"
+```
+
+To search a specific folder, add `--folder FOLDER_ID`.
+
+## Other useful commands
+
+| Task | Command |
+| --- | --- |
+| Check which account is signed in | `wondersearch whoami` |
+| List documents | `wondersearch document list` |
+| List folders | `wondersearch folder list` |
+| Create a folder | `wondersearch folder create "Research"` |
+| Check account usage | `wondersearch usage` |
+| Check storage | `wondersearch storage` |
+| Sign out of the CLI | `wondersearch logout` |
+
+Signing out of the CLI leaves you signed in to the Console.
+
+## Use in scripts
+
+Add `--json` to a command for output your script can read:
+
+```sh
+wondersearch search "What is our refund policy?" --json
+```
+
+For automation, sign in with an API key using `wondersearch login --api-key`.
+Paste the key at the hidden prompt. API keys can only access the workspace and
+actions they have permission to use.
+
+## Get help
+
+Use `--help` to see the available commands and options:
+
+```sh
+wondersearch --help
+wondersearch upload --help
+wondersearch search --help
+```

wondersearch_cli-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling>=1.26,<2"]
+build-backend = "hatchling.build"
+
+[project]
+name = "wondersearch-cli"
+dynamic = ["version"]
+description = "Command-line client for WonderSearch"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = ["httpx>=0.27,<1", "packaging>=24,<27", "keyring>=25,<26"]
+
+[project.optional-dependencies]
+dev = ["hatchling>=1.26,<2", "pytest>=8,<10", "ruff>=0.11,<1", "mypy>=1.15,<2", "build>=1.2,<2", "twine>=6,<7"]
+
+[project.scripts]
+wondersearch = "wondersearch_cli.main:main"
+
+[tool.hatch.version]
+path = "src/wondersearch_cli/_version.py"
+
+[tool.hatch.build.targets.wheel]
+core-metadata-version = "2.4"
+packages = ["src/wondersearch_cli"]
+
+[tool.hatch.build.targets.sdist]
+core-metadata-version = "2.4"
+include = ["/src", "/tests", "/README.md", "/CHANGELOG.md", "/LICENSE", "/pyproject.toml"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.ruff]
+target-version = "py310"
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F"]
+
+[tool.mypy]
+python_version = "3.10"
+check_untyped_defs = true

wondersearch_cli-0.1.0/src/wondersearch_cli/__init__.py

@@ -0,0 +1,5 @@
+"""WonderSearch command-line client."""
+
+from ._version import __version__
+
+__all__ = ["__version__"]

wondersearch_cli-0.1.0/src/wondersearch_cli/__main__.py

@@ -0,0 +1,3 @@
+from .main import main
+
+raise SystemExit(main())