A CLI for R2C
Project description
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
pipor viapipxto provide better package isolation.pip3 install r2c-cli -
Run
r2cto 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
r2ccommands, you can run with--verboseflag and reach out tosupport@ret2.cowith the error log.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file r2c-cli-0.0.24.tar.gz.
File metadata
- Download URL: r2c-cli-0.0.24.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.0b5 CPython/3.7.7 Darwin/19.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd44283a785d1cf46e77f5eb46f4d206607aa6adc4a094bd9a363fdaf79b4dd9 |
|
| MD5 | f3054378664164af95ebce313f82e46d |
|
| BLAKE2b-256 | c64f47563d1a46febc1b6dc5cab566a9c8577045a4f8e4ccacb22d7e59f47f8f |
File details
Details for the file r2c_cli-0.0.24-py3-none-any.whl.
File metadata
- Download URL: r2c_cli-0.0.24-py3-none-any.whl
- Upload date:
- Size: 31.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.0b5 CPython/3.7.7 Darwin/19.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b444e510dfef4be5ae7cf40614f916a83ce3f9b9dee013bf93c12f3516a29551 |
|
| MD5 | 4fa6a2c0bc6dac154234fe32a641e3e7 |
|
| BLAKE2b-256 | a2ae802419631ecec7a049fb55d52595619ebcd755a89bf8e2a46ab87ae41fd6 |
