npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tokenscript/cli

v1.2.5

Published

A tool for managing tokenscript projects

Downloads

57

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jsbrownjsbrownstj89stj89jf-stljf-stlfutantanfutantanjot2rejot2remicwallacemicwallacevictor928victor928nicholastarasnicholastaras

Keywords

oclif

Readme

TokenScript CLI

TokenScript CLI is tool for managing TokenScript projects.

The CLI currently includes commands for:

  • Creating/initializing projects based on a set of inbuilt templates or contract ABIs
  • Building the project into a TSML and validating the output
  • Emulating a TokenScript in the browser with live reload
  • Signing & validating TokenScripts for distribution

Note: ABI import support is experimental and only works for one template

oclif

Installation & Usage

$ npm install -g @tokenscript/cli
$ tokenscript COMMAND
running command...
$ tokenscript (--version)
@tokenscript/cli/1.2.5 linux-x64 node-v18.18.2
$ tokenscript --help [COMMAND]
USAGE
  $ tokenscript COMMAND
...

Creating a TokenScript project

$ tokenscript create my-project-dir

When executing this command you will be asked a series of questions according to the template you selected. It is recommended to use the Svelte or typescript template to benefit from type checking, including for Card SDK types.

Once the project is successfully initialized you can build or emulate the project:

$ cd my-project-dir
my-project-dir$ npm run build

If all goes well you should see a file in ./out/tokenscript.tsml

my-project-dir$ npm run emulate

Your browser will open TokenScript viewer and load your project. You can make changes to your project and the CLI will rebuild & reload as you code.

Development

The CLI is built using oclif.

Development dependencies

The TokenScript CLI requires libxml2js which in turn requires node-gyp to build. This comes bundled with newer versions of npm but may need some dependencies installed depending on your operating system.

Please follow the guide at the node-gyp GIT repo to ensure that it's working.

Use locally

You can run the CLI from source in developer mode like this:

$ git clone https://github.com/TokenScript/tokenscript-cli.git
$ cd tokenscript-cli
$ npm i
$ ./bin/dev

You can also install the package globally on your system like this:

$ npm run build
$ npm link

Note: Rebuilding will update the global version

Framework requirements

TokenScript is compatible with almost any frontend framework. Currently only Svelte template is available but React is coming soon. The only requirement is that the builder/bundler is capable of exporting to a deterministic set of files that can be referenced for inclusion within tokenscript.xml.

It is recommended to export as a single page application and rely on document.location.hash for routing.

Please get in touch with us if you need assistance creating your own templates.

Commands

tokenscript build [ENVIRONMENT]

Build the tokenscript project into a .tsml

USAGE
  $ tokenscript build [ENVIRONMENT] [-t]

ARGUMENTS
  ENVIRONMENT  [default: default] The environment configuration to use for the build

FLAGS
  -t, --outputTemplate  Output a .tsml template that can be used to serve TokenScripts on-the-fly for multiple contracts

DESCRIPTION
  Build the tokenscript project into a .tsml

See code: src/commands/build.ts

tokenscript certificate COMMAND

Create a certificate request or sign an existing request.

USAGE
  $ tokenscript certificate COMMAND [-k <value>] [-m <value>] [-r <value>] [-r <value>] [-c <value>]

ARGUMENTS
  COMMAND  (request|sign) Whether to create a signing 'request' or 'sign' an existing request

FLAGS
  -c, --cn=<value>                    The CN for the certificate, or issuer CN if signing
  -k, --privateKeyFile=<value>        [default: ts-signing.key] Hex encoded private key filename (for creating CSR)
  -m, --masterPrivateKeyFile=<value>  [default: ts-master.key] Hex encoded master private key filename (for signing CSR)
  -r, --certFile=<value>              [default: ts-certificate.pem] Certificate PEM input or output filename
  -r, --certRequestFile=<value>       [default: ts-certificate-request.pem] Certificate signing request PEM input or
                                      output filename

DESCRIPTION
  Create a certificate request or sign an existing request.

See code: src/commands/certificate.ts

tokenscript create [DIRECTORY]

Create a new TokenScript project

USAGE
  $ tokenscript create [DIRECTORY] [-t emptySvelte|emptyReact|emptyTypescript|empty] [-h <value>]

FLAGS
  -h, --hardHat=<value>    Directory of HardHat project
  -t, --template=<option>  <options: emptySvelte|emptyReact|emptyTypescript|empty>

DESCRIPTION
  Create a new TokenScript project

See code: src/commands/create.ts

tokenscript emulate [ENVIRONMENT]

Emulate the TokenScript in a browser

USAGE
  $ tokenscript emulate [ENVIRONMENT] [-e <value>]

ARGUMENTS
  ENVIRONMENT  [default: default] The environment configuration to use for the build

FLAGS
  -e, --emulatorHost=<value>

DESCRIPTION
  Emulate the TokenScript in a browser

See code: src/commands/emulate.ts

tokenscript help [COMMANDS]

Display help for tokenscript.

USAGE
  $ tokenscript help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for tokenscript.

See code: @oclif/plugin-help

tokenscript plugins

List installed plugins.

USAGE
  $ tokenscript plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ tokenscript plugins

See code: @oclif/plugin-plugins

tokenscript plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ tokenscript plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ tokenscript plugins add

EXAMPLES
  $ tokenscript plugins:install myplugin 

  $ tokenscript plugins:install https://github.com/someuser/someplugin

  $ tokenscript plugins:install someuser/someplugin

tokenscript plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ tokenscript plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ tokenscript plugins:inspect myplugin

See code: @oclif/plugin-plugins

tokenscript plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ tokenscript plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ tokenscript plugins add

EXAMPLES
  $ tokenscript plugins:install myplugin 

  $ tokenscript plugins:install https://github.com/someuser/someplugin

  $ tokenscript plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

tokenscript plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ tokenscript plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ tokenscript plugins:link myplugin

See code: @oclif/plugin-plugins

tokenscript plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ tokenscript plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tokenscript plugins unlink
  $ tokenscript plugins remove

tokenscript plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ tokenscript plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tokenscript plugins unlink
  $ tokenscript plugins remove

See code: @oclif/plugin-plugins

tokenscript plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ tokenscript plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tokenscript plugins unlink
  $ tokenscript plugins remove

tokenscript plugins update

Update installed plugins.

USAGE
  $ tokenscript plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

tokenscript refresh

Refresh a HardHat project

USAGE
  $ tokenscript refresh

DESCRIPTION
  Refresh a HardHat project

See code: src/commands/refresh.ts

tokenscript sign

sign the built .tsml

USAGE
  $ tokenscript sign [-v] [-k <value>] [-p <value>] [-r <value>]

FLAGS
  -k, --privateKeyFile=<value>  [default: ts-signing.key] Hex encoded private key file location
  -p, --publicKeyFile=<value>   [default: ts-signing.pub] Hex encoded private key file location
  -r, --certFile=<value>        [default: /home/michael/PhpstormProjects/tokenscript-cli/ts-certificate.pem] Certificate
                                PEM filename
  -v, --verify                  Verify existing signed .tsml

DESCRIPTION
  sign the built .tsml

See code: src/commands/sign.ts

tokenscript validate

Validate an existing .tsml

USAGE
  $ tokenscript validate

DESCRIPTION
  Validate an existing .tsml

See code: src/commands/validate.ts