跳转到主要内容

R2C的命令行界面

项目描述

r2c-cli

这是与R2C平台交互的命令行界面。

安装

先决条件

设置

  • 安装r2c-cli,您可以通过 pip 或通过 pipx 来提供更好的包隔离。

    pip3 install r2c-cli
    
  • 运行 r2c 以检查CLI是否正确安装。如果正确安装,您应该看到我们的帮助文本。

文档

有关如何使用 r2c-cli 编写分析器的详细信息,请参阅 docs.r2c.dev

用法

r2c <command> [options]

您还可以运行 r2c --help 或直接运行 r2c 以查看用法信息。

对于特定命令的帮助,您可以运行 r2c <command> --help 以查看该命令的特定帮助。

对于 runtestpushunittest 命令,它们需要在分析器目录中运行(即包含 analyzer.json 和相关文件的目录)。

单元测试

运行单元测试的说明定义在 src/unittest.sh 中。请确保将 mocha testnpm test 添加到您的分析器中,以启用单元测试。

集成测试

集成测试应在 src/examples 目录中定义。在github REPO@COMMIT上的集成测试可以定义为

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

上传新的分析器

一旦您在本地上完成开发并测试分析器,您必须更新 analyzer.json 中的 version 并运行

r2c push

将分析器上传到您的仓库。

故障排除

  • 如果在运行 r2c 命令时遇到问题,可以使用 --verbose 标志运行,并带有错误日志联系 support@ret2.co

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪一个,请了解更多关于 安装包 的信息。

源代码分布

r2c-cli-0.0.24.tar.gz (25.0 kB 查看哈希值)

上传时间 源代码

构建分布

r2c_cli-0.0.24-py3-none-any.whl (31.6 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面