r2c-cli

This is the CLI for interacting with the R2C platform.

Installation

Prerequisites

Install Docker for your platform
Python 3.7 and up for your platform

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.

Metadata

Release files for r2c-cli 0.0.24

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for r2c-cli 0.0.24
File	Size	Uploaded	Provenance
r2c-cli-0.0.24.tar.gz	25.0 kB	May 2, 2020	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for r2c-cli 0.0.24
File	Interpreter	ABI	Platform	Reset
r2c_cli-0.0.24-py3-none-any.whl 31.6 kB May 2, 2020 Without provenance	Python 3	none	any	Details

Total release size: 56.6 kB

Release files / r2c-cli-0.0.24.tar.gz

Download URL	r2c-cli-0.0.24.tar.gz
Size	25.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`cd44283a785d1cf46e77f5eb46f4d206607aa6adc4a094bd9a363fdaf79b4dd9`
BLAKE2b-256 checksum How to use checksums	`c64f47563d1a46febc1b6dc5cab566a9c8577045a4f8e4ccacb22d7e59f47f8f`
Upload date	May 2, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.0.0b5 CPython/3.7.7 Darwin/19.4.0`

Release files / r2c_cli-0.0.24-py3-none-any.whl

Download URL	r2c_cli-0.0.24-py3-none-any.whl
Size	31.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b444e510dfef4be5ae7cf40614f916a83ce3f9b9dee013bf93c12f3516a29551`
BLAKE2b-256 checksum How to use checksums	`a2ae802419631ecec7a049fb55d52595619ebcd755a89bf8e2a46ab87ae41fd6`
Upload date	May 2, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.0.0b5 CPython/3.7.7 Darwin/19.4.0`

Security for r2c-cli 0.0.24

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.