{"id":13772542,"url":"https://github.com/wavesplatform/Surfboard","last_synced_at":"2025-05-11T04:31:35.524Z","repository":{"id":35001265,"uuid":"190387824","full_name":"wavesplatform/surfboard","owner":"wavesplatform","description":"Command line interface for working with waves RIDE language","archived":false,"fork":false,"pushed_at":"2023-03-03T00:40:23.000Z","size":1877,"stargazers_count":10,"open_issues_count":16,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-04T11:04:53.808Z","etag":null,"topics":["waves"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wavesplatform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-05T12:10:52.000Z","updated_at":"2024-01-16T03:08:20.000Z","dependencies_parsed_at":"2024-06-21T05:46:14.614Z","dependency_job_id":"69989c91-d5fc-4901-a2bd-0e41a4d33301","html_url":"https://github.com/wavesplatform/surfboard","commit_stats":null,"previous_names":["wavesplatform/ride-cli"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wavesplatform%2Fsurfboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wavesplatform%2Fsurfboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wavesplatform%2Fsurfboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wavesplatform%2Fsurfboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wavesplatform","download_url":"https://codeload.github.com/wavesplatform/surfboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253518941,"owners_count":21921074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["waves"],"created_at":"2024-08-03T17:01:05.185Z","updated_at":"2025-05-11T04:31:30.504Z","avatar_url":"https://github.com/wavesplatform.png","language":"TypeScript","readme":"Surfboard\n=========\n\nSurfboard is a command line interface for working with RIDE programming language. Surfboard allows to compile RIDE scripts, deploy and run tests. \n\nSurfboard requires `nodejs`. \n\nThe full manual how to use different tools for Waves dApps you can find [here](https://blog.wavesplatform.com/how-to-build-deploy-and-test-a-waves-ride-dapp-785311f58c2)\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Version](https://img.shields.io/npm/v/@waves/ride-cli.svg)](https://npmjs.org/package/@waves/ride-cli)\n[![Downloads/week](https://img.shields.io/npm/dw/@waves/ride-cli.svg)](https://npmjs.org/package/@waves/ride-cli)\n[![License](https://img.shields.io/npm/l/@waves/ride-cli.svg)](https://github.com/wavesplatform/ride-cli/blob/master/package.json)\n\n\u003c!-- toc --\u003e\n* [Installation](#installation)\n* [Usage](#usage)\n* [Commands](#commands)\n\u003c!-- tocstop --\u003e\n# Installation\nSurfboard is distributed as npm package. To install run `npm i -g @waves/surfboard`\n\n# Usage\nFor all commands surboard tries to use `surfboard.config.json`. If it is not present, surfboard falls back to global config. You can change global config by using `config:change` with `-g` flag \n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g @waves/surfboard\n$ surfboard COMMAND\nrunning command...\n$ surfboard (-v|--version|version)\n@waves/surfboard/2.3.0 darwin-x64 node-v17.0.1\n$ surfboard --help [COMMAND]\nUSAGE\n  $ surfboard COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n# Commands\n\u003c!-- commands --\u003e\n* [`surfboard compile FILE`](#surfboard-compile-file)\n* [`surfboard config:change KEY VALUE`](#surfboard-configchange-key-value)\n* [`surfboard config:show [KEY]`](#surfboard-configshow-key)\n* [`surfboard help [COMMAND]`](#surfboard-help-command)\n* [`surfboard init`](#surfboard-init)\n* [`surfboard repl`](#surfboard-repl)\n* [`surfboard run FILE`](#surfboard-run-file)\n* [`surfboard test [FILE]`](#surfboard-test-file)\n\n## `surfboard compile FILE`\n\ncompile ride file\n\n```\nUSAGE\n  $ surfboard compile FILE\n\nARGUMENTS\n  FILE  path to ride file\n\nOPTIONS\n  --fullInfo  outputs JSON with additional info. Such as complexity, size etc.\n```\n\n_See code: [src/commands/compile.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/compile.ts)_\n\n## `surfboard config:change KEY VALUE`\n\nchange config\n\n```\nUSAGE\n  $ surfboard config:change KEY VALUE\n\nARGUMENTS\n  KEY    config option key in dot notion\n  VALUE  config option value\n\nOPTIONS\n  -g, --global  change global config\n```\n\n_See code: [src/commands/config/change.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/config/change.ts)_\n\n## `surfboard config:show [KEY]`\n\nshow config\n\n```\nUSAGE\n  $ surfboard config:show [KEY]\n\nARGUMENTS\n  KEY  Config option key in dot notation\n\nOPTIONS\n  -g, --global  Show global config\n```\n\n_See code: [src/commands/config/show.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/config/show.ts)_\n\n## `surfboard help [COMMAND]`\n\ndisplay help for surfboard\n\n```\nUSAGE\n  $ surfboard help [COMMAND]\n\nARGUMENTS\n  COMMAND  command to show help for\n\nOPTIONS\n  --all  see all commands in CLI\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_\n\n## `surfboard init`\n\ninitialize new Ride project\n\n```\nUSAGE\n  $ surfboard init\n```\n\n_See code: [src/commands/init.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/init.ts)_\n\n## `surfboard repl`\n\nrun ride repl\n\n```\nUSAGE\n  $ surfboard repl\n\nOPTIONS\n  --env=env  which environment should be used for test\n```\n\n_See code: [src/commands/repl.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/repl.ts)_\n\n## `surfboard run FILE`\n\nrun js script with with blockchain context\n\n```\nUSAGE\n  $ surfboard run FILE\n\nARGUMENTS\n  FILE  path to script\n\nOPTIONS\n  --env=env              which environment should be used\n\n  --variables=variables  env variables can be set for usage in script via env.{variable_name}. E.g.: MY_SEED=\"seed\n                         phraze\",DAPP_ADDRESS=\"xyz\"\n```\n\n_See code: [src/commands/run.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/run.ts)_\n\n## `surfboard test [FILE]`\n\nrun test\n\n```\nUSAGE\n  $ surfboard test [FILE]\n\nARGUMENTS\n  FILE  path to test file\n\nOPTIONS\n  -v, --verbose          logs all transactions and node responses\n  --env=env              which environment should be used for test\n\n  --variables=variables  env variables can be set for usage in tests via env.{variable_name}. E.g.: MY_SEED=\"seed\n                         phraze\",DAPP_ADDRESS=xyz, AMOUNT=1000\n```\n\n_See code: [src/commands/test.ts](https://github.com/wavesplatform/surfboard/blob/v2.3.0/src/commands/test.ts)_\n\u003c!-- commandsstop --\u003e\n","funding_links":[],"categories":["Frameworks and tools"],"sub_categories":["The Ride programming language"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwavesplatform%2FSurfboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwavesplatform%2FSurfboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwavesplatform%2FSurfboard/lists"}