Client Guides#111
Merged
Merged
Conversation
caidobot
requested a deployment
to
ae-sdk-client-guides - doc-developer PR #111
Render
In progress
There was a problem hiding this comment.
Pull request overview
Adds a new “Client Guides” documentation section describing how to use the Caido Client SDK for setup/auth, core data access (requests/findings/environments), plugin interaction (install/call/subscribe), and advanced usage (raw GraphQL + custom token cache), and wires the pages into the VitePress guides sidebar.
Changes:
- Introduces a set of new Client SDK how-to guide pages under
src/guides/client/. - Documents plugin function calls/events in both explicit and spec-typed forms.
- Updates the guides sidebar to include the new “Client Guides” navigation group.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 23 comments.
Show a summary per file
| File | Description |
|---|---|
| src/guides/client/install.md | New guide for installing @caido/sdk-client. |
| src/guides/client/base_setup.md | New guide for auth, token caching, connecting, and first call. |
| src/guides/client/extract_requests.md | New guide for listing/filtering/paginating requests via client.request. |
| src/guides/client/manage_findings.md | New guide for listing/creating/updating findings via client.finding. |
| src/guides/client/environments.md | New guide for managing environments/variables via client.environment. |
| src/guides/client/install_plugin.md | New guide for installing plugins via client.plugin.install() from store or zip. |
| src/guides/client/call_function.md | New guide for calling backend plugin functions via pkg.callFunction(). |
| src/guides/client/receive_events.md | New guide for subscribing to backend plugin events via pkg.subscribeEvent(). |
| src/guides/client/spec_typing.md | New guide for using plugin spec npm packages to get typed calls/events. |
| src/guides/client/graphql_direct.md | New guide for issuing raw GraphQL queries/mutations/subscriptions. |
| src/guides/client/custom_cache.md | New guide for implementing a custom TokenCache. |
| .vitepress/sidebars/guides.ts | Adds “Client Guides” section and links to the new pages. |
Comment on lines
+151
to
+156
| Run it with: | ||
|
|
||
| ```bash | ||
| export CAIDO_PAT=caido_xxxxx | ||
| node ./index.ts | ||
| ``` |
|
|
||
| ```bash | ||
| export CAIDO_PAT=caido_xxxxx | ||
| node ./index.ts |
|
|
||
| ```bash | ||
| export CAIDO_PAT=caido_xxxxx | ||
| node ./index.ts |
|
|
||
| ```bash | ||
| export CAIDO_PAT=caido_xxxxx | ||
| node ./index.ts |
|
|
||
| ```bash | ||
| export CAIDO_PAT=caido_xxxxx | ||
| node ./index.ts |
Comment on lines
+172
to
+177
| ## Example | ||
|
|
||
| A complete script that uses an in-memory cache, connects, fetches the viewer, and clears the cache on exit: | ||
|
|
||
| ### index.ts | ||
|
|
Comment on lines
+110
to
+115
| ## Example | ||
|
|
||
| The script below looks up the installed `quickssrf` plugin, fetches its available providers, and creates a session against the first one. | ||
|
|
||
| ### index.ts | ||
|
|
Comment on lines
+176
to
+181
| ## Example | ||
|
|
||
| The script below combines everything above using PAT authentication and a file cache. | ||
|
|
||
| ### index.ts | ||
|
|
Comment on lines
+14
to
+16
| ## 1. From the Caido Store | ||
|
|
||
| To install a plugin from the store, you need its **manifest ID**. This is the `id` field declared in the plugin's `manifest.json` file, and it is what uniquely identifies the plugin in the store. You can find it in the [store manifest](https://github.com/caido/store/blob/main/plugin_packages.json) or in the plugin's repository under [caido-community](https://github.com/caido-community). |
Comment on lines
+39
to
+42
| ## 2. From a Local Package File | ||
|
|
||
| To install a plugin from a local archive, you need its **plugin package**. This is a signed `.zip` file attached to each [plugin release](/guides/repository.md#5-create-a-release) on GitHub. Download the archive, load it into a `File` object, then pass it to `install()`. | ||
|
|
* Add Authentication Methods Concept * Add: Authentication Caching of Tokens concept * Add Community implementations Concepts * Add Scanner API toturial (#113)
caidobot
temporarily deployed
to
ae-sdk-client-guides - doc-developer PR #111
Render
Destroyed
Corb3nik
approved these changes
May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.