0.1.0 • Published 5 years ago

@auditless/cli v0.1.0

Weekly downloads
1
License
MPL-2.0
Repository
github
Last release
5 years ago

auditless-cli

Auditless generates unit tests for your smart contracts. Learn more at auditless.com

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g @auditless/cli
$ auditless COMMAND
running command...
$ auditless (-v|--version|version)
@auditless/cli/0.1.0 darwin-x64 node-v10.0.0
$ auditless --help [COMMAND]
USAGE
  $ auditless COMMAND
...

Commands

auditless auto

generate test cases automatically

USAGE
  $ auditless auto

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ auditless auto
  TBD

See code: src/commands/auto.ts

auditless help [COMMAND]

display help for auditless

USAGE
  $ auditless help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

auditless semi [CONTRACTFILE] [CALLSFILE]

generate test cases from call sequences

USAGE
  $ auditless semi [CONTRACTFILE] [CALLSFILE]

OPTIONS
  -h, --help                       show CLI help
  -n, --contractName=contractName  contract to test, e.g., Crowdsale
  -s, --server=server              use a custom server url

EXAMPLE
  $ auditless semi ERC20.sol erc20.yaml
  $ auditless semi Crowdsale.sol crowdsale.yaml -n CrowdsaleContract

  Example YAML file structure:
  # Each series of function calls is a single test
  -
     - ['totalSupply']
     - ['mint', 0xCAFE, 100] # Equivalent to contract call mint(0xCAFE, 100)
     - ['totalSupply']
  # Two tests of 3 function calls each will be generated
  -
     - ['balanceOf', 0xCAFE]
     - ['mint', 0xCAFE, 100]
     - ['balanceOf', 0xCAFE]

See code: src/commands/semi.ts