Communications Mining 开发者指南

上次更新日期 2024年12月20日

概述

Communications Mining 命令行接口re是一个统一工具，它提供一致的界面，用于从终端与 Communications Mining 的所有部分进行交互。

re简化了管理 Communications Mining 资源（例如源和数据集）以及导入或导出通信数据的过程。此外， re维护多个上下文，让您可以轻松地为不同用户、服务帐户或 Communications Mining 端点在多个身份验证令牌之间切换。

Communications Mining CLI 是开源的，在GitHub 上开发。

功能

所有不同 Communications Mining 资源的“创建”、“获取”、“更新”和“删除”操作。这包括来源、数据集、注释、存储桶、流等。
多个 API 令牌和 Communications Mining 端点的上下文管理。
轻松将新消息上传到来源。
从一组来源和数据集中下载消息以及人工应用的注释。用于备份、迁移数据或对数据应用某些转换。
zsh和bash的基本 Shell 自动补全、彩色终端输出、进度条等

安装

二进制

为所有主要平台提供没有依赖项的静态链接二进制文件

从来源

要从源代码构建，您需要安装最新版本的Rust工具链。使用货物进行安装。

cargo install --locked reinfer-clicargo install --locked reinfer-cli

确保路径中包含“cargo bin”目录（通常为~/.cargo/bin ）。

或者，您始终可以克隆存储库并使用cargo build进行构建。

Help

Communications Mining CLI 附带大量命令文档，可通过--help或-h标志访问这些文档。

$ re --help
$ re <command> --help
$ re <command> <subcommand> --help$ re --help
$ re <command> --help
$ re <command> <subcommand> --help

我们鼓励您阅读包含的文档，因为它内容丰富且始终是最新的。

$ re --help

reinfer-cli 0.11.0
re is the command line interface to reinfer clusters

USAGE:
    re [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Enable more verbose logging

OPTIONS:
    -k, --accept-invalid-certificates <accept-invalid-certificates>
        --config-file <config>
            Path to the configuration file. Typically defaults to ~/.config/reinfer on Linux

    -c, --context <context>
            Specify what context to use. Overrides the current context, if any

        --endpoint <endpoint>
            Specify what endpoint to use. Overrides the one from the current context, if any

    -o, --output <output>
            Output format. One of: json, table [default: table]

        --proxy <proxy>
            URL for an HTTP proxy that will be used for all requests if specified

        --token <token>
            Specify what API token to use. Overrides the one from the current context, if any


SUBCOMMANDS:
    completion    Output shell completion code for the specified shell (bash or zsh)
    config        Manage reinfer authentication and endpoint contexts
    create        Create new resources
    delete        Delete a resource
    get           Display resources and export comments to the local filesystem
    help          Prints this message or the help of the given subcommand(s)
    update        Update existing resources$ re --help

reinfer-cli 0.11.0
re is the command line interface to reinfer clusters

USAGE:
    re [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Enable more verbose logging

OPTIONS:
    -k, --accept-invalid-certificates <accept-invalid-certificates>
        --config-file <config>
            Path to the configuration file. Typically defaults to ~/.config/reinfer on Linux

    -c, --context <context>
            Specify what context to use. Overrides the current context, if any

        --endpoint <endpoint>
            Specify what endpoint to use. Overrides the one from the current context, if any

    -o, --output <output>
            Output format. One of: json, table [default: table]

        --proxy <proxy>
            URL for an HTTP proxy that will be used for all requests if specified

        --token <token>
            Specify what API token to use. Overrides the one from the current context, if any


SUBCOMMANDS:
    completion    Output shell completion code for the specified shell (bash or zsh)
    config        Manage reinfer authentication and endpoint contexts
    create        Create new resources
    delete        Delete a resource
    get           Display resources and export comments to the local filesystem
    help          Prints this message or the help of the given subcommand(s)
    update        Update existing resources

故障排除

要使用 Communications Mining CLI 排除问题，以下方法可能有用

确保已安装最新版本的re 。通过运行re --version或re -V获取已安装的版本
--verbose标志可打印调试消息，这可能会缩小问题的范围。
连接问题可能是由于代理设置配置不正确所致。请参阅使用代理配置请求代理。
Communications Mining CLI 配置目录特定于系统，例如在 Linux 或 macOS 上为~/.config/reinfer ，在 Windows 上为%AppData%/reinfer 。您可以安全地将其删除，并且 CLI 将重新填充该 ID，但所有配置（包括用户会话）都将丢失。

如果您认为我们可以采取任何改进措施，或者遇到任何错误或意外行为，请联系支持团队。

在此页面上