diff --git a/README.md b/README.md index 1aba53b..923917a 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,13 @@ in place: and read the result before signing anything. Inspect and replay past transactions, analyse where gas actually went, and query events. + + + Explore a package: open the Package Explorer, load your published packages, pick or paste a package ID, fetch its normalized modules over gRPC, render the interface, then copy for AI, inspect, or build a move-call. + + +Exploring a package — from a wall of `UpgradeCap`s to a callable interface. Interactive version: [open it live](https://htmlpreview.github.io/?https://raw.githubusercontent.com/harrymove-ctrl/sui-cli-web/master/docs/diagrams/explore-package-flow.html). + **Environments and keys.** Switch between mainnet, testnet, devnet and a local node. Request faucet tokens. Manage addresses across key schemes. Private keys stay in your Sui config — the one endpoint that returns raw key material is @@ -69,6 +76,13 @@ instead of being handed shell access to `sui`. ## How it works + + + Sui CLI Web architecture: a web client and an MCP AI agent on your machine talk to a local Fastify server, which shells out to the sui CLI (holding your keystore) and reads the Sui network — fullnode gRPC, GraphQL, and faucet. + + +Animated overview — the request dots trace a browser call (`client → server → gRPC`) and an agent call (`MCP → server → GraphQL`). Interactive version with a ☀/☾ theme toggle and ⏯ pause: [open it live](https://htmlpreview.github.io/?https://raw.githubusercontent.com/harrymove-ctrl/sui-cli-web/master/docs/diagrams/sui-cli-web-architecture.html) · source in [`docs/diagrams/`](docs/diagrams/). + Three pieces, one of which you already have: ``` diff --git a/docs/diagrams/explore-package-flow-dark.gif b/docs/diagrams/explore-package-flow-dark.gif new file mode 100644 index 0000000..397d03d Binary files /dev/null and b/docs/diagrams/explore-package-flow-dark.gif differ diff --git a/docs/diagrams/explore-package-flow-light.gif b/docs/diagrams/explore-package-flow-light.gif new file mode 100644 index 0000000..1b205f1 Binary files /dev/null and b/docs/diagrams/explore-package-flow-light.gif differ diff --git a/docs/diagrams/explore-package-flow.html b/docs/diagrams/explore-package-flow.html new file mode 100644 index 0000000..7cdad3d --- /dev/null +++ b/docs/diagrams/explore-package-flow.html @@ -0,0 +1,106 @@ + + + + + + +Explore a package — glowmotion + + + +
+

Explore a packagecap to callable

@sui-cli-web
+

My Packages → interface → interact

+
+
+ Explore a package animated diagramTop-down flow diagram; dashed connectors animate in the direction of flow and glowing dots ride the main paths.have idbrowsecopyinspectcallOpen Package ExplorerLoad My PackagesKnow the package ID?Paste a package IDPick one of your packagesexplorePackage → /exploregRPC · normalized modulesRender interfaceWhat next?Copy for AIOpen in Object tabBuild a move-call +
+ +

Runs against the active env's RPC — the same network everything else in the app uses.

+
+ + + + + \ No newline at end of file diff --git a/docs/diagrams/sui-cli-web-architecture-dark.gif b/docs/diagrams/sui-cli-web-architecture-dark.gif new file mode 100644 index 0000000..f08beb5 Binary files /dev/null and b/docs/diagrams/sui-cli-web-architecture-dark.gif differ diff --git a/docs/diagrams/sui-cli-web-architecture-light.gif b/docs/diagrams/sui-cli-web-architecture-light.gif new file mode 100644 index 0000000..1e02678 Binary files /dev/null and b/docs/diagrams/sui-cli-web-architecture-light.gif differ diff --git a/docs/diagrams/sui-cli-web-architecture.html b/docs/diagrams/sui-cli-web-architecture.html new file mode 100644 index 0000000..4e705b3 --- /dev/null +++ b/docs/diagrams/sui-cli-web-architecture.html @@ -0,0 +1,116 @@ + + + + + + +Sui CLI Web — glowmotion + + + +
+

Sui CLI Weblocal-first

@sui-cli-web
+

A keyboard-first web UI over your own sui toolchain

+
+
+ Sui CLI Web animated diagramTop-down architecture diagram; dashed connectors animate in the direction of flow and glowing dots ride the main paths.Your machineSui networkREST /apiMCP toolsshell-outread stackobjects · packagesqueriesgasAI agentMCP clientWeb clientReact · ViteLocal serverFastifysui CLIkeystore · signsdevstacklocal dev stackFullnodegRPCGraphQLindexerFaucettestnet gasexternalfrontendservicesecuritycloud infrarequest in flight +
+

Local-first

  • • Server runs on your machine
  • • Keys stay in the sui keystore

Reads over gRPC

  • • Objects, coins & packages
  • • GraphQL for rich queries

Agent-ready

  • • MCP tools for AI agents
  • • No keys in the model's context
+

Every balance, object and package is scoped to the active RPC environment.

+
+ + + + + \ No newline at end of file