@dowse-dev/cli 0.1.0 → 0.2.0

package/LICENSE

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

package/README.md

@@ -18,9 +18,22 @@ Supported agents: `claude-code`, `cursor`, `codex`, `vscode`, `gemini-cli`, `her
 | `doctor [--agent <name>]` | Reports for each agent whether it is installed and configured, whether its key is valid and whether the server can be reached. Each problem comes with a repair. |
 | `disconnect [--all \| --agent <name>]` | Removes Dowse and its skill. Leaves everything else alone. |
 | `search <query>` | Searches the web. Options: `--max-results <1-20>`, `--depth basic\|advanced`, `--topic general\|news`, `--country <code>`, `--answer`. |
-| `extract <url...>` | Reads pages. Option: `--depth basic\|advanced`. |
+| `extract <url...>` | Reads pages. Options: `--depth basic\|advanced`, `--format text\|markdown`. |
+| `map <url>` | Lists the URLs of a site, from its sitemap and links. Options: `--max-depth <1-5>`, `--max-breadth <1-500>`, `--limit <1-5000>`, `--select-paths <regex>`, `--exclude-paths <regex>`, `--select-domains <regex>`, `--exclude-domains <regex>`, `--allow-external`, `--sitemap include\|skip\|only`, `--timeout <10-90>`. The regex flags can repeat. |
+| `crawl <url>` | Reads many pages of one site. Takes the `map` options, but `--limit` goes to 100, plus `--depth basic\|advanced`, `--format text\|markdown` (default markdown) and `--max-chars <n>`. |
+| `apps <store> <action> [<id> \| <query>]` | App Store (`apple`) and Google Play (`google`) data. See [Apps](#apps). |
 
-`search` and `extract` spend credits: a search costs 1, or 2 with `--depth advanced`. Extracting costs 1 per 5 URLs, or 2 with `--depth advanced`. Failed calls are free.
+`search`, `extract`, `map`, `crawl` and `apps` spend credits:
+
+- `search`: 1 credit, or 2 with `--depth advanced`.
+- `extract`: 1 credit per 5 URLs. A page that needs a browser costs 1 more. With `--depth advanced`, a blocked page can go to a paid reader for 2 more instead.
+- `map`: 1 credit per 10 URLs returned, at most 10.
+- `crawl`: 1 credit per 10 pages read, plus their `extract` price.
+- `apps`: 1 credit per call that returns data. Errors and empty results are free.
+
+Failed calls and failed pages are free. Every cost is on the [pricing page](https://dowse.dev/pricing).
+
+`map` and `crawl` respect the start site's robots.txt. The `stopped` field of their output says why a walk ended early (`limit` or `deadline`).
 
 After `connect` they need no key, because they use the one in your agent's config. Otherwise pass `--api-key` or set `DOWSE_API_KEY`.
 
@@ -28,6 +41,23 @@ Output is JSON on stdout, so agents can read it. Add `--pretty` for a version me
 
 Each repair has `unattended_safe`. It's `true` when the repair only changes the Dowse entry or just waits, and `false` when it changes something else or needs a person.
 
+## Apps
+
+`apps <store> <action>` reads one page of app store data. `<store>` is `apple` or `google`.
+
+- `app`, `reviews`, `similar`, `ratings`, `privacy`, `versions` take an app id: on the App Store the number (`324684580`) or the bundle id (`com.spotify.client`), on Google Play the package name (`com.spotify.music`). `developer` takes a developer id.
+- `search` and `suggest` take a query. `list` (a top chart) takes neither.
+- `ratings`, `privacy` and `versions` are App Store only.
+- Options: `--country <code>` (default `us`), `--language <code>`, `--limit <n>` (search, list, developer, Google Play reviews), `--sort <s>` (reviews), `--offset <n>` (App Store reviews), `--cursor <c>` (Google Play reviews), `--collection <c>` and `--category <c>` (list).
+- `data` holds each store's own fields, which differ between the stores. For the next page of reviews, pass `next_offset` as `--offset` (App Store) or `next_cursor` as `--cursor` with the same `--sort` (Google Play). No `next_offset` or `next_cursor` means the last page.
+
+```sh
+npx -y @dowse-dev/cli@latest apps apple app 324684580
+npx -y @dowse-dev/cli@latest apps google search "podcast" --limit 10
+npx -y @dowse-dev/cli@latest apps apple reviews 324684580 --sort helpful --offset 20
+npx -y @dowse-dev/cli@latest apps google list --collection top_free --category GAME
+```
+
 ## What it does to your configs
 
 - Only the `dowse` entry changes. Other servers, settings, comments and formatting stay as they were.
@@ -43,3 +73,7 @@ Each repair has `unattended_safe`. It's `true` when the repair only changes the
 The skill goes in `~/.agents/skills/dowse`, which Codex, Cursor, VS Code and Gemini CLI read, in `~/.claude/skills/dowse` for Claude Code, and in `~/.hermes/skills/dowse` for Hermes. It holds no key.
 
 If you edit the skill, your copy is kept, and `disconnect` leaves it too. Anything else already named `dowse` there is left alone and reported.
+
+## License
+
+MIT. This covers the installer only; the Dowse service has its own [terms](https://dowse.dev/terms).