CLI-opdrachten

De surfpool CLI start lokale Surfnets, voert Runbooks uit, toont Runbooks van een workspace-manifest, genereert shell-aanvullingen en start de Surfpool MCP-server.

Opdrachten

Opdracht	Beschrijving
`surfpool start`	Start een lokaal Surfnet. Alias: `surfpool simnet`
`surfpool run`	Voer een Runbook uit
`surfpool ls`	Geef Runbooks weer in de huidige workspace
`surfpool completions`	Genereer shell-aanvullingsscripts
`surfpool mcp`	Start de Surfpool MCP-server

`surfpool start`

Start een lokaal Surfnet. Als u het uitvoert in een Solana-programmamap, kan Surfpool automatisch Runbooks genereren en uitvoeren die uw programma's implementeren.

surfpool start [OPTIONS]

Netwerk & Poorten

Vlag	Kort	Type	Standaard	Beschrijving
`--port <PORT>`	`-p`	integer	`8899`	Koppel de JSON-RPC-server aan deze poort.
`--ws-port <PORT>`	`-w`	integer	`8900`	Koppel de WebSocket-server aan deze poort.
`--host <HOST>`	`-o`	string	`127.0.0.1`	Koppel RPC-, WebSocket- en Studio-services aan deze host.
`--rpc-url <RPC_URL>`	`-u`	string	geen	Fork vanaf deze databron-RPC-URL. Conflicteert met `--network`. Kan ook worden ingesteld met `SURFPOOL_DATASOURCE_RPC_URL`.
`--network <NETWORK>`	`-n`	enum	geen	Fork vanaf een vooraf gedefinieerd Solana-netwerk. Waarden: `mainnet`, `devnet`, `testnet`. Conflicteert met `--rpc-url`.
`--offline`	geen	boolean	`false`	Uitvoeren zonder een externe RPC-databron.

Project & Implementatie

Vlag	Kort	Type	Standaard	Beschrijving
`--manifest-file-path <MANIFEST_PATH>`	`-m`	path	`./txtx.yml`	Pad naar het runbook-manifest.
`--no-deploy`	none	boolean	`false`	Automatische programma-implementaties uitschakelen.
`--runbook <RUNBOOK>`	`-r`	string[]	`deployment`	Runbook-ID om uit te voeren na het opstarten. Herhaalbaar.
`--runbook-input <INPUT_PATH>`	`-i`	path[]	none	Invoerbestand voor de runbook-uitvoering. Herhaalbaar.
`--yes`	`-y`	boolean	`false`	Runbook-generatieprompts overslaan.
`--watch`	none	boolean	`false`	Opnieuw implementeren wanneer programma-artefacten wijzigen.
`--artifacts-path <ARTIFACTS_PATH>`	none	path	none	Map met `.so` programma-artefacten. Standaard `target/deploy` indien weggelaten.
`--legacy-anchor-compatibility`	none	boolean	`false`	Gebruik standaardinstellingen die geschikt zijn voor verouderde Anchor-testsuites.
`--anchor-test-config-path <TEST_TOML>`	none	path[]	none	Anchor `Test.toml` bestand om te inspecteren. Herhaalbaar.

Accounts & Status

Vlag	Kort	Type	Standaard	Beschrijving
`--airdrop <PUBKEY>`	`-a`	pubkey[]	none	pubkey om bij het opstarten SOL naar te airdroppen. Herhaalbaar.
`--airdrop-keypair-path <KEYPAIR_PATH>`	`-k`	path[]	`~/.config/solana/id.json`	keypair-pad waarvan de pubkey een airdrop moet ontvangen. Herhaalbaar.
`--airdrop-amount <LAMPORTS>`	`-q`	integer	`10000000000000`	lamports om te airdroppen naar elk opstartaccount.
`--snapshot <SNAPSHOT_PATH>`	none	path[]	none	JSON-accountsnapshot om vooraf te laden. Herhaalbaar. Latere bestanden overschrijven eerdere bestanden bij dubbele sleutels.
`--db <DB_URL>`	none	string	none	Databaseverbindings-URL voor persistente Surfnet-status. Gebruik `:memory:` voor in-memory SQLite, een `.sqlite` bestand voor SQLite op schijf, of een PostgreSQL-URL indien gebouwd met de `postgres` functie.
`--surfnet-id <SURFNET_ID>`	none	string	`default`	Opslagnaamruimte voor deze Surfnet-instantie.

Runtime & UI

Vlag	Kort	Type	Standaard	Beschrijving
`--no-tui`	geen	boolean	`false`	Logs afdrukken in plaats van de terminal-UI starten.
`--no-studio`	geen	boolean	`false`	Surfpool Studio uitschakelen.
`--studio-port <PORT>`	`-s`	integer	`18488`	Studio aan deze poort koppelen.
`--daemon`	geen	boolean	`false`	Surfpool als achtergrondproces uitvoeren. Daemonmodus is alleen beschikbaar op Linux.
`--ci`	geen	boolean	`false`	Instellingen gebruiken die geschikt zijn voor CI. Dit schakelt de TUI, Studio, instructieprofilering en loguitvoer uit.

SVM-gedrag

Vlag	Kort	Type	Standaard	Beschrijving
`--slot-time <MILLISECONDS>`	`-t`	integer	`400`	Slot-tijd in milliseconden.
`--block-production-mode <MODE>`	`-b`	enum	`clock`	Blokproductiemodus.
`--feature <FEATURE_PUBKEY>`	`-f`	pubkey[]	geen	Een SVM-functie inschakelen via pubkey. Herhaalbaar. Functienamen zijn verouderd maar worden nog steeds geaccepteerd voor eerder ondersteunde namen.
`--disable-feature <FEATURE_PUBKEY>`	geen	pubkey[]	geen	Een SVM-functie uitschakelen via pubkey. Herhaalbaar. Functienamen zijn verouderd maar worden nog steeds geaccepteerd voor eerder ondersteunde namen.
`--features-all`	geen	boolean	`false`	Alle SVM-functies inschakelen vanuit `agave-feature-set`.
`--skip-signature-verification`	geen	boolean	`false`	Verificatie van transactiehandtekeningen overslaan.
`--skip-blockhash-check`	geen	boolean	`false`	Validatie van transactieblockhash overslaan.

Observeerbaarheid & Prestaties

Flag	Short	Type	Default	Description
`--geyser-plugin-config <PLUGIN_CONFIG_PATH>`	`-g`	path[]	none	Geyser plugin configuratiebestand om te laden. Herhaalbaar.
`--disable-instruction-profiling`	none	boolean	`false`	Instructieprofilering uitschakelen.
`--max-profiles <COUNT>`	`-c`	integer	`200`	Transactieprofielen die in het geheugen worden bewaard. Hogere waarden verhogen het geheugengebruik.
`--log-bytes-limit <BYTES>`	none	integer	`10000`	Maximaal aantal bytes opgeslagen per transactielog. Stel in op `0` voor onbeperkte logs.
`--log-level <LEVEL>`	`-l`	enum	`info`	Simnet logniveau. Waarden: `trace`, `debug`, `info`, `warn`, `error`, `none`.
`--log-path <LOG_DIR>`	none	path	`.surfpool/logs`	Map voor simnet-logs.
`--metrics-enabled`	none	boolean	env: `SURFPOOL_METRICS_ENABLED`	Het Prometheus-metrieken-eindpunt inschakelen. Beschikbaar wanneer Surfpool is gebouwd met de `prometheus`-functie.
`--metrics-addr <METRICS_ADDR>`	none	string	`127.0.0.1:9000`	Adres van het Prometheus-metrieken-eindpunt. Kan ook worden ingesteld met `SURFPOOL_METRICS_ADDR`. Beschikbaar wanneer Surfpool is gebouwd met de `prometheus`-functie.

Verouderde Compatibiliteit

Flag	Short	Type	Default	Description
`--subgraph-db <SUBGRAPH_DB>`	`-d`	string	`:memory:`	Verouderd en verborgen in `surfpool start --help`. Bestaande scripts kunnen het nog steeds doorgeven voor compatibiliteit.

Voorbeelden

Starten met standaardinstellingen:

surfpool start

Devnet forken:

surfpool start --network devnet

Gebruik een aangepaste databron-RPC-URL:

surfpool start --rpc-url https://api.mainnet-beta.solana.com

Logs afdrukken in plaats van de TUI starten:

surfpool start --no-tui

Starten zonder een externe RPC-gegevensbron:

surfpool start --offline

SOL airdroppen naar meerdere accounts:

surfpool start --airdrop <PUBKEY> --airdrop <PUBKEY>

Accountstatus laden vanuit snapshots:

surfpool start --snapshot ./snapshot1.json --snapshot ./snapshot2.json

Programma's opnieuw implementeren wanneer target/deploy wijzigt:

surfpool start --watch

Surfnet-status opslaan in een SQLite-database op schijf:

surfpool start --db ./surfnet.sqlite --surfnet-id local-dev

`surfpool run`

Voert een Runbook uit. U kunt een .tx bestand rechtstreeks uitvoeren of verwijzen naar een Runbook gedeclareerd in een txtx.yml manifest.

surfpool run [OPTIONS] <RUNBOOK>

Argumenten

Argument	Type	Beschrijving
`<RUNBOOK>`	string	Runbook-ID uit `txtx.yml`, of pad naar een `.tx` bestand.

Project

Vlag	Kort	Type	Standaard	Beschrijving
`--manifest-file-path <MANIFEST_PATH>`	`-m`	pad	`./txtx.yml`	Pad naar het runbook-manifest.
`--env <ENVIRONMENT>`	geen	string	geen	Omgeving uit `txtx.yml` om te gebruiken.

Uitvoeringsmodus

Deze vlaggen sluiten elkaar uit. Als er geen is opgegeven, gebruikt Surfpool browser-supervisie.

Vlag	Kort	Type	Standaard	Beschrijving
`--unsupervised`	`-u`	boolean	`false`	Uitvoeren zonder de supervisor-UI.
`--browser`	`-b`	boolean	standaardmodus	Uitvoeren met supervisie in de browser-UI.
`--terminal`	`-t`	boolean	`false`	Uitvoeren met supervisie in de terminalterminal.

Invoer & Uitvoer

Vlag	Kort	Type	Standaard	Beschrijving
`--output-json [<OUTPUT_DIR>]`	geen	optioneel pad	geen	Runbook-uitvoer afdrukken of wegschrijven als JSON. Wanneer een map wordt opgegeven, wordt de uitvoer naar een bestand in die map geschreven.
`--output <OUTPUT_NAME>`	geen	string	geen	Eén benoemde uitvoer afdrukken aan het einde van de uitvoering. Conflicteert met `--output-json`.
`--input <INPUT_PATH>`	geen	pad[]	geen	Invoerbestand voor batchverwerking. Herhaalbaar.

Uitvoering

Vlag	Kort	Type	Standaard	Beschrijving
`--explain`	geen	boolean	`false`	Uitleggen hoe het Runbook wordt uitgevoerd.
`--force`	`-f`	boolean	`false`	Gecachte uitvoeringstoestand negeren.

Supervisor UI

Deze vlaggen zijn beschikbaar wanneer Surfpool is gebouwd met de supervisor_ui functie.

Vlag	Kort	Type	Standaard	Beschrijving
`--port <PORT>`	`-p`	integer	`8488`	Web UI-poort.
`--ip <IP_ADDRESS>`	`-i`	string	`127.0.0.1`	Web UI-IP-adres.

Logboekregistratie

Vlag	Kort	Type	Standaard	Beschrijving
`--log-level <LEVEL>`	`-l`	enum	`info`	Logniveau voor Runbook-uitvoering. Waarden: `trace`, `debug`, `info`, `warn`, `error`.
`--log-path <LOG_DIR>`	geen	pad	`.surfpool/logs`	Map voor logboeken van Runbook-uitvoering.

Voorbeelden

Voer een manifest Runbook uit met browserbewaking:

surfpool run deployment

Voer uit zonder bewaking en schrijf JSON-uitvoer:

surfpool run deployment --unsupervised --output-json .surfpool/runbook-outputs

Voer een .tx bestand direct uit:

surfpool run ./runbooks/deployment.tx

`surfpool ls`

Geeft een lijst van alle Runbooks die zijn gedeclareerd in het werkruimtemanifest.

surfpool ls [OPTIONS]

Vlag	Kort	Type	Standaard	Beschrijving
`--manifest-file-path <MANIFEST_PATH>`	`-m`	pad	`./txtx.yml`	Pad naar het runbook-manifest.

`surfpool completions`

Genereert shell-voltooiingsscripts.

surfpool completions <SHELL>

Argument	Type	Beschrijving
`<SHELL>`	enum	Shell waarvoor voltooiingen worden gegenereerd. Waarden: `bash`, `elvish`, `fish`, `powershell`, `zsh`.

`surfpool mcp`

Start de Surfpool MCP-server voor AI-toolintegratie.

surfpool mcp

Inhoudsopgave