CLI-komennot

surfpool CLI käynnistää paikalliset Surfnetit, suorittaa Runbookit, listaa Runbookit työtilamanifestista, luo shell-täydennykset ja käynnistää Surfpool MCP -palvelimen.

Komennot

Komento	Kuvaus
`surfpool start`	Käynnistä paikallinen Surfnet. Alias: `surfpool simnet`
`surfpool run`	Suorita Runbook
`surfpool ls`	Listaa Runbookit nykyisessä työtilassa
`surfpool completions`	Luo shell-täydennysskriptit
`surfpool mcp`	Käynnistä Surfpool MCP -palvelin

`surfpool start`

Käynnistää paikallisen Surfnetin. Jos suoritat sen Solana-ohjelmahakemistossa, Surfpool voi luoda ja suorittaa Runbookeja, jotka ottavat ohjelmasi käyttöön.

surfpool start [OPTIONS]

Verkko ja portit

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--port <PORT>`	`-p`	kokonaisluku	`8899`	Sido JSON-RPC-palvelin tähän porttiin.
`--ws-port <PORT>`	`-w`	kokonaisluku	`8900`	Sido WebSocket-palvelin tähän porttiin.
`--host <HOST>`	`-o`	merkkijono	`127.0.0.1`	Sido RPC-, WebSocket- ja Studio-palvelut tähän isäntään.
`--rpc-url <RPC_URL>`	`-u`	merkkijono	ei mitään	Haaraudu tästä tietolähteen RPC-URL-osoitteesta. Ristiriidassa `--network`:n kanssa. Voidaan myös asettaa `SURFPOOL_DATASOURCE_RPC_URL`:llä.
`--network <NETWORK>`	`-n`	enum	ei mitään	Haaraudu ennalta määritetystä Solana-verkosta. Arvot: `mainnet`, `devnet`, `testnet`. Ristiriidassa `--rpc-url`:n kanssa.
`--offline`	ei mitään	boolean	`false`	Suorita ilman etä-RPC-tietolähdettä.

Projekti & Käyttöönotto

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--manifest-file-path <MANIFEST_PATH>`	`-m`	path	`./txtx.yml`	Polku runbook-manifestiin.
`--no-deploy`	none	boolean	`false`	Poista automaattiset ohjelmien käyttöönotot käytöstä.
`--runbook <RUNBOOK>`	`-r`	string[]	`deployment`	Runbook-tunnus, joka suoritetaan käynnistyksen jälkeen. Toistettavissa.
`--runbook-input <INPUT_PATH>`	`-i`	path[]	none	Syötetiedosto runbook-suoritukselle. Toistettavissa.
`--yes`	`-y`	boolean	`false`	Ohita runbook-luonnin kehotteet.
`--watch`	none	boolean	`false`	Ota uudelleenkäyttöön, kun ohjelma-artefaktit muuttuvat.
`--artifacts-path <ARTIFACTS_PATH>`	none	path	none	Hakemisto, joka sisältää `.so`-ohjelma-artefaktit. Oletuksena `target/deploy`, jos jätetty tyhjäksi.
`--legacy-anchor-compatibility`	none	boolean	`false`	Käytä oletusasetuksia, jotka sopivat legacy Anchor -testipaketeille.
`--anchor-test-config-path <TEST_TOML>`	none	path[]	none	Anchor `Test.toml` -tiedosto tarkasteltavaksi. Toistettavissa.

Tilit & Tila

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--airdrop <PUBKEY>`	`-a`	pubkey[]	none	pubkey, jolle airdropataan SOL käynnistyksessä. Toistettavissa.
`--airdrop-keypair-path <KEYPAIR_PATH>`	`-k`	path[]	`~/.config/solana/id.json`	keypair-polku, jonka pubkey vastaanottaa airdropia. Toistettavissa.
`--airdrop-amount <LAMPORTS>`	`-q`	integer	`10000000000000`	lamport-määrä, joka airdropataan kullekin käynnistystilille.
`--snapshot <SNAPSHOT_PATH>`	none	path[]	none	JSON-tilimomentti esilataukseen. Toistettavissa. Myöhemmät tiedostot korvaavat aiemmat tiedostot päällekkäisten avainten osalta.
`--db <DB_URL>`	none	string	none	Tietokantayhteyden URL pysyvää Surfnet-tilaa varten. Käytä `:memory:` muistissa olevaan SQLite-tietokantaan, `.sqlite`-tiedostoa levyllä olevaan SQLite-tietokantaan tai PostgreSQL-URL:ää, kun rakennettu `postgres`-ominaisuudella.
`--surfnet-id <SURFNET_ID>`	none	string	`default`	Tallennusnimiavaruus tälle Surfnet-instanssille.

Ajoympäristö & käyttöliittymä

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--no-tui`	none	boolean	`false`	Tulosta lokit terminaalikäyttöliittymän käynnistämisen sijaan.
`--no-studio`	none	boolean	`false`	Poista Surfpool Studio käytöstä.
`--studio-port <PORT>`	`-s`	integer	`18488`	Sido Studio tähän porttiin.
`--daemon`	none	boolean	`false`	Suorita Surfpool taustaprosessina. Daemon-tila on vain Linux-käyttöön.
`--ci`	none	boolean	`false`	Käytä CI-ympäristöön sopivia asetuksia. Tämä poistaa käytöstä TUI:n, Studion, käskyprofiloinnin ja lokitulosteen.

SVM-käyttäytyminen

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--slot-time <MILLISECONDS>`	`-t`	integer	`400`	Slot-aika millisekunteina.
`--block-production-mode <MODE>`	`-b`	enum	`clock`	Lohkontuotantotila.
`--feature <FEATURE_PUBKEY>`	`-f`	pubkey[]	none	Ota SVM-ominaisuus käyttöön pubkey-tunnuksella. Toistettavissa. Ominaisuuksien nimet ovat vanhentuneita, mutta niitä hyväksytään edelleen aiemmin tuetuille nimille.
`--disable-feature <FEATURE_PUBKEY>`	none	pubkey[]	none	Poista SVM-ominaisuus käytöstä pubkey-tunnuksella. Toistettavissa. Ominaisuuksien nimet ovat vanhentuneita, mutta niitä hyväksytään edelleen aiemmin tuetuille nimille.
`--features-all`	none	boolean	`false`	Ota käyttöön kaikki SVM-ominaisuudet kohteesta `agave-feature-set`.
`--skip-signature-verification`	none	boolean	`false`	Ohita tapahtuman allekirjoituksen vahvistus.
`--skip-blockhash-check`	none	boolean	`false`	Ohita tapahtuman lohkotiivisteen vahvistus.

Havaittavuus & Suorituskyky

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--geyser-plugin-config <PLUGIN_CONFIG_PATH>`	`-g`	path[]	ei mitään	Ladattava Geyser-laajennuksen asetustiedosto. Toistettavissa.
`--disable-instruction-profiling`	ei mitään	boolean	`false`	Poista käskyn profilointi käytöstä.
`--max-profiles <COUNT>`	`-c`	integer	`200`	Muistiin säilytettävät transaktioprofiilit. Suuremmat arvot kasvattavat muistin käyttöä.
`--log-bytes-limit <BYTES>`	ei mitään	integer	`10000`	Kullekin transaktiolokille tallennettava enimmäistavu. Aseta `0` rajattomille lokeille.
`--log-level <LEVEL>`	`-l`	enum	`info`	Simnet-lokitaso. Arvot: `trace`, `debug`, `info`, `warn`, `error`, `none`.
`--log-path <LOG_DIR>`	ei mitään	path	`.surfpool/logs`	Simnet-lokien hakemisto.
`--metrics-enabled`	ei mitään	boolean	env: `SURFPOOL_METRICS_ENABLED`	Ota Prometheus-mittauslähtöpiste käyttöön. Saatavilla, kun Surfpool on rakennettu `prometheus`-ominaisuudella.
`--metrics-addr <METRICS_ADDR>`	ei mitään	string	`127.0.0.1:9000`	Prometheus-mittauslähtöpisteen osoite. Voidaan myös asettaa käyttämällä `SURFPOOL_METRICS_ADDR`. Saatavilla, kun Surfpool on rakennettu `prometheus`-ominaisuudella.

Poistettu yhteensopivuus

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--subgraph-db <SUBGRAPH_DB>`	`-d`	string	`:memory:`	Vanhentunut ja piilotettu kohteesta `surfpool start --help`. Olemassa olevat skriptit voivat silti välittää sen yhteensopivuuden vuoksi.

Esimerkit

Käynnistä oletusasetuksilla:

surfpool start

Haaroita devnet:

surfpool start --network devnet

Käytä mukautettua tietolähdettä RPC-URL:lla:

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

Tulosta lokit TUI:n käynnistämisen sijaan:

surfpool start --no-tui

Käynnistä ilman etä-RPC-tietolähdettä:

surfpool start --offline

Airdrop SOL useille tileille:

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

Lataa tilin tila tilannekuvista:

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

Ota ohjelmat uudelleen käyttöön, kun target/deploy muuttuu:

surfpool start --watch

Tallenna Surfnetin tila levyllä olevaan SQLite-tietokantaan:

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

`surfpool run`

Suorittaa Runbookin. Voit ajaa .tx-tiedoston suoraan tai viitata txtx.yml-manifestissa määriteltyyn Runbookiin.

surfpool run [OPTIONS] <RUNBOOK>

Argumentit

Argumentti	Tyyppi	Kuvaus
`<RUNBOOK>`	merkkijono	Runbook-tunnus `txtx.yml`:sta tai polku `.tx`-tiedostoon.

Projekti

Lippu	Lyhenne	Tyyppi	Oletus	Kuvaus
`--manifest-file-path <MANIFEST_PATH>`	`-m`	polku	`./txtx.yml`	Polku runbook-manifestiin.
`--env <ENVIRONMENT>`	ei mitään	merkkijono	ei mitään	Ympäristö `txtx.yml`:sta käytettäväksi.

Suoritustila

Nämä liput ovat toisiaan poissulkevia. Jos mitään ei ole määritetty, Surfpool käyttää selainvalvontaa.

Lippu	Lyhenne	Tyyppi	Oletus	Kuvaus
`--unsupervised`	`-u`	totuusarvo	`false`	Suorita ilman valvojan käyttöliittymää.
`--browser`	`-b`	totuusarvo	oletustila	Suorita valvonnalla selaimen käyttöliittymässä.
`--terminal`	`-t`	totuusarvo	`false`	Suorita valvonnalla terminaalikonsolissa.

Syötteet ja tulosteet

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--output-json [<OUTPUT_DIR>]`	ei mitään	valinnainen polku	ei mitään	Tulosta tai kirjoita Runbook-tulosteet JSON-muodossa. Kun hakemisto annetaan, tulosteet kirjoitetaan tiedostoon kyseisessä hakemistossa.
`--output <OUTPUT_NAME>`	ei mitään	merkkijono	ei mitään	Tulosta yksi nimetty tuloste suorituksen lopussa. Ristiriidassa `--output-json`:n kanssa.
`--input <INPUT_PATH>`	ei mitään	polku[]	ei mitään	Syötetiedosto eräkäsittelyä varten. Toistettavissa.

Suoritus

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--explain`	ei mitään	totuusarvo	`false`	Selitä, miten Runbook suoritetaan.
`--force`	`-f`	totuusarvo	`false`	Ohita välimuistiin tallennettu suoritustila.

Valvontakäyttöliittymä

Nämä liput ovat käytettävissä, kun Surfpool on rakennettu supervisor_ui-ominaisuudella.

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--port <PORT>`	`-p`	kokonaisluku	`8488`	Verkkokäyttöliittymän portti.
`--ip <IP_ADDRESS>`	`-i`	merkkijono	`127.0.0.1`	Verkkokäyttöliittymän IP-osoite.

Lokitus

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--log-level <LEVEL>`	`-l`	enum	`info`	Runbook-suorituksen lokitaso. Arvot: `trace`, `debug`, `info`, `warn`, `error`.
`--log-path <LOG_DIR>`	ei mitään	polku	`.surfpool/logs`	Hakemisto Runbook-suorituslokeja varten.

Esimerkit

Suorita manifest Runbook selaimen valvonnalla:

surfpool run deployment

Suorita ilman valvontaa ja kirjoita JSON-tulosteet:

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

Suorita .tx-tiedosto suoraan:

surfpool run ./runbooks/deployment.tx

`surfpool ls`

Listaa kaikki työtilan manifestissa määritellyt Runbookit.

surfpool ls [OPTIONS]

Lippu	Lyhyt	Tyyppi	Oletus	Kuvaus
`--manifest-file-path <MANIFEST_PATH>`	`-m`	polku	`./txtx.yml`	Polku runbook-manifestiin.

`surfpool completions`

Luo shell-täydennyskomentosarjoja.

surfpool completions <SHELL>

Argumentti	Tyyppi	Kuvaus
`<SHELL>`	enum	Shell, jolle täydennykset luodaan. Arvot: `bash`, `elvish`, `fish`, `powershell`, `zsh`.

`surfpool mcp`

Käynnistää Surfpool MCP -palvelimen tekoälytyökalujen integrointia varten.

surfpool mcp

Sisällysluettelo