libcli 开源项目教程

libcli 开源项目教程

libcliLibcli provides a shared library for including a Cisco-like command-line interface into other software. It's a telnet interface which supports command-line editing, history, authentication and callbacks for a user-definable function tree.项目地址:https://gitcode.com/gh_mirrors/li/libcli

1. 项目的目录结构及介绍

libcli 项目的目录结构如下：

libcli/
├── AUTHORS
├── COPYING
├── Makefile
├── README
├── cli.c
├── cli.h
├── cli_file.c
├── cli_list.c
├── cli_misc.c
├── cli_pipe.c
├── cli_session.c
├── cli_tree.c
├── cli_vty.c
├── cli_vty.h
├── cli_vtysh.c
├── cli_vtysh.h
├── examples/
│   ├── example1.c
│   ├── example2.c
│   └── example3.c
├── tests/
│   ├── test1.c
│   └── test2.c
└── utils/
    ├── util1.c
    └── util2.c

目录介绍

• AUTHORS 和 COPYING：包含项目的作者信息和许可证信息。
• Makefile：用于编译项目的 Makefile 文件。
• README：项目的说明文档。
• cli.c 和 cli.h：核心库文件。
• cli_file.c, cli_list.c, cli_misc.c, cli_pipe.c, cli_session.c, cli_tree.c, cli_vty.c, cli_vty.h, cli_vtysh.c, cli_vtysh.h：库的不同模块文件。
• examples/：示例代码目录，包含多个示例程序。
• tests/：测试代码目录，包含多个测试程序。
• utils/：实用工具代码目录，包含多个实用工具程序。

2. 项目的启动文件介绍

项目的启动文件主要是 cli.c，它是 libcli 库的核心文件。该文件包含了库的主要功能实现，包括命令行接口的初始化和处理逻辑。

3. 项目的配置文件介绍

libcli 项目本身没有特定的配置文件，其配置主要通过代码中的参数和选项进行设置。例如，在 cli.c 文件中，可以通过设置不同的参数来配置命令行接口的行为。

示例配置

在 examples/example1.c 中，可以看到如何使用 libcli 库进行配置：

#include "cli.h"

int main() {
    struct cli_def *cli = cli_init();
    cli_set_banner(cli, "Example CLI");
    cli_set_hostname(cli, "example");

    // 添加命令
    struct cli_command *cmd = cli_register_command(cli, NULL, "show", NULL, 0, 0);
    cli_register_command(cli, cmd, "version", show_version, 0, 0);

    // 启动 CLI
    cli_loop(cli);
    cli_free(cli);

    return 0;
}

在这个示例中，通过 cli_set_banner 和 cli_set_hostname 函数来设置命令行接口的标题和主机名。

libcliLibcli provides a shared library for including a Cisco-like command-line interface into other software. It's a telnet interface which supports command-line editing, history, authentication and callbacks for a user-definable function tree.项目地址:https://gitcode.com/gh_mirrors/li/libcli