Skip to main content

A CLI for R2C

Project description

r2c-cli

This is the CLI for interacting with the R2C platform.

Installation

Prerequisites

Setup

  • Install r2c-cli, either via pip or via pipx to provide better package isolation.

    pip3 install r2c-cli
    
  • Run r2c to check that the CLI was installed properly. If installed properly, you should see our help text.

Documentation

See docs.r2c.dev for details on how write analyzer using r2c-cli.

Usage

r2c <command> [options]

You can also run r2c --help or just r2c to see usage information.

For help with a command in particular, you can run r2c <command> --help and see help specifically for that command.

For the commands run test push and unittest they will require that you run them in an analyzer directory (i.e. a directory containing an analyzer.json and associated files).

Unit Testing

Instructions to run unittests are defined src/unittest.sh. Make sure to add mocha test or npm test to enable unittesting for your analyzer.

Integration Testing

Integration tests should be defined in the src/examples directory. Integration test on a github REPO@COMMIT could be defined as

{
  "target": "{REPO}",
  "target_hash": "{COMMIT}",
  "expected": []
}

Uploading new analyzer

Once you are done developing and testing your analyzer locally, you must update version in your analyzer.json and run

r2c push

to upload your analyzer to your repository.

Troubleshooting

  • If you run into issues running r2c commands, you can run with --verbose flag and reach out to support@ret2.co with the error log.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for r2c-cli, version 0.0.24b0
Filename, size File type Python version Upload date Hashes
Filename, size r2c_cli-0.0.24b0-py3-none-any.whl (31.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size r2c-cli-0.0.24b0.tar.gz (24.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page