Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

feat: categorize commands #1245

Merged
merged 3 commits into from
Sep 18, 2024
Merged

feat: categorize commands #1245

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3a599e
feat: categorize commands
vansangpfiev Sep 18, 2024
f572eff
fix: usage
vansangpfiev Sep 18, 2024
77c491c
Merge branch 'dev' into feat/categorize-commands
vansangpfiev Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
305 changes: 162 additions & 143 deletions engine/controllers/command_line_parser.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,161 +20,175 @@
#include "utils/file_manager_utils.h"
#include "utils/logging_utils.h"

namespace {
constexpr const auto kCommonCommandsGroup = "Common Commands";
constexpr const auto kInferenceGroup = "Inference";
constexpr const auto kModelsGroup = "Models";
constexpr const auto kEngineGroup = "Engines";
constexpr const auto kSystemGroup = "System";
} // namespace
CommandLineParser::CommandLineParser()
: app_("Cortex.cpp CLI"), engine_service_{EngineService()} {}

bool CommandLineParser::SetupCommand(int argc, char** argv) {
app_.usage(commands::GetCortexBinary() + " [OPTIONS] [SUBCOMMAND]");
auto config = file_manager_utils::GetCortexConfig();
std::string model_id;
std::string msg;

// Models group commands
{
auto models_cmd =
app_.add_subcommand("models", "Subcommands for managing models");

auto start_cmd = models_cmd->add_subcommand("start", "Start a model by ID");
start_cmd->add_option("model_id", model_id, "");
start_cmd->callback([&model_id, &config]() {
commands::CmdInfo ci(model_id);
std::string model_file =
ci.branch == "main" ? ci.model_name : ci.model_name + "-" + ci.branch;
config::YamlHandler yaml_handler;
yaml_handler.ModelConfigFromFile(
file_manager_utils::GetModelsContainerPath().string() + "/" +
model_file + ".yaml");
commands::ModelStartCmd msc(config.apiServerHost,
std::stoi(config.apiServerPort),
yaml_handler.GetModelConfig());
msc.Exec();
});

auto stop_model_cmd =
models_cmd->add_subcommand("stop", "Stop a model by ID");
stop_model_cmd->add_option("model_id", model_id, "");
stop_model_cmd->callback([&model_id, &config]() {
commands::CmdInfo ci(model_id);
std::string model_file =
ci.branch == "main" ? ci.model_name : ci.model_name + "-" + ci.branch;
config::YamlHandler yaml_handler;
yaml_handler.ModelConfigFromFile(
file_manager_utils::GetModelsContainerPath().string() + "/" +
model_file + ".yaml");
commands::ModelStopCmd smc(config.apiServerHost,
std::stoi(config.apiServerPort),
yaml_handler.GetModelConfig());
smc.Exec();
});

auto list_models_cmd =
models_cmd->add_subcommand("list", "List all models locally");
list_models_cmd->callback([]() { commands::ModelListCmd().Exec(); });

auto get_models_cmd =
models_cmd->add_subcommand("get", "Get info of {model_id} locally");
get_models_cmd->add_option("model_id", model_id, "");
get_models_cmd->callback([&model_id]() {
commands::ModelGetCmd command(model_id);
command.Exec();
});

{
auto model_pull_cmd =
app_.add_subcommand("pull",
"Download a model by URL (or HuggingFace ID) "
"See built-in models: https://huggingface.co/cortexso");
model_pull_cmd->add_option("model_id", model_id, "");
model_pull_cmd->callback([&model_id]() {
try {
commands::ModelPullCmd().Exec(model_id);
} catch (const std::exception& e) {
CLI_LOG(e.what());
}
});
auto model_pull_cmd = app_.add_subcommand(
"pull",
"Download a model by URL (or HuggingFace ID) "
"See built-in models: https://huggingface.co/cortexso");
model_pull_cmd->group(kCommonCommandsGroup);
model_pull_cmd->add_option("model_id", model_id, "");
model_pull_cmd->require_option();
model_pull_cmd->callback([&model_id]() {
try {
commands::ModelPullCmd().Exec(model_id);
} catch (const std::exception& e) {
CLI_LOG(e.what());
}
});

auto model_del_cmd =
models_cmd->add_subcommand("delete", "Delete a model by ID locally");
model_del_cmd->add_option("model_id", model_id, "");
auto run_cmd =
app_.add_subcommand("run", "Shortcut to start a model and chat");
run_cmd->group(kCommonCommandsGroup);
run_cmd->add_option("model_id", model_id, "");
run_cmd->require_option();
run_cmd->callback([&model_id, &config] {
commands::RunCmd rc(config.apiServerHost, std::stoi(config.apiServerPort),
model_id);
rc.Exec();
});

model_del_cmd->callback([&model_id]() {
commands::ModelDelCmd mdc;
mdc.Exec(model_id);
});
auto chat_cmd = app_.add_subcommand("chat", "Send a chat completion request");
chat_cmd->group(kCommonCommandsGroup);
chat_cmd->add_option("model_id", model_id, "");
chat_cmd->require_option();
chat_cmd->add_option("-m,--message", msg, "Message to chat with model");
chat_cmd->callback([&model_id, &msg, &config] {
if (model_id.empty()) {
CLI_LOG("Please input [model_id] in command!");
return;
}
commands::CmdInfo ci(model_id);
std::string model_file =
ci.branch == "main" ? ci.model_name : ci.model_name + "-" + ci.branch;
config::YamlHandler yaml_handler;
yaml_handler.ModelConfigFromFile(
file_manager_utils::GetModelsContainerPath().string() + "/" +
model_file + ".yaml");
commands::ChatCmd cc(config.apiServerHost, std::stoi(config.apiServerPort),
yaml_handler.GetModelConfig());
cc.Exec(msg);
});

auto update_cmd =
models_cmd->add_subcommand("update", "Update configuration of a model");
}
auto embeddings_cmd = app_.add_subcommand(
"embeddings", "Creates an embedding vector representing the input text");
embeddings_cmd->group(kInferenceGroup);

std::string msg;
{
auto chat_cmd =
app_.add_subcommand("chat", "Send a chat completion request");

chat_cmd->add_option("model_id", model_id, "");
chat_cmd->add_option("-m,--message", msg, "Message to chat with model");

chat_cmd->callback([&model_id, &msg, &config] {
commands::CmdInfo ci(model_id);
std::string model_file =
ci.branch == "main" ? ci.model_name : ci.model_name + "-" + ci.branch;
config::YamlHandler yaml_handler;
yaml_handler.ModelConfigFromFile(
file_manager_utils::GetModelsContainerPath().string() + "/" +
model_file + ".yaml");
commands::ChatCmd cc(config.apiServerHost,
std::stoi(config.apiServerPort),
yaml_handler.GetModelConfig());
cc.Exec(msg);
});
}
// Models group commands
auto models_cmd =
app_.add_subcommand("models", "Subcommands for managing models");
models_cmd->group(kModelsGroup);
models_cmd->require_subcommand();

auto model_start_cmd =
models_cmd->add_subcommand("start", "Start a model by ID");
model_start_cmd->add_option("model_id", model_id, "");
model_start_cmd->require_option();
model_start_cmd->callback([&model_id, &config]() {
commands::CmdInfo ci(model_id);
std::string model_file =
ci.branch == "main" ? ci.model_name : ci.model_name + "-" + ci.branch;
config::YamlHandler yaml_handler;
yaml_handler.ModelConfigFromFile(
file_manager_utils::GetModelsContainerPath().string() + "/" +
model_file + ".yaml");
commands::ModelStartCmd msc(config.apiServerHost,
std::stoi(config.apiServerPort),
yaml_handler.GetModelConfig());
msc.Exec();
});

auto ps_cmd =
app_.add_subcommand("ps", "Show running models and their status");
auto stop_model_cmd =
models_cmd->add_subcommand("stop", "Stop a model by ID");
stop_model_cmd->add_option("model_id", model_id, "");
stop_model_cmd->require_option();
stop_model_cmd->callback([&model_id, &config]() {
commands::CmdInfo ci(model_id);
std::string model_file =
ci.branch == "main" ? ci.model_name : ci.model_name + "-" + ci.branch;
config::YamlHandler yaml_handler;
yaml_handler.ModelConfigFromFile(
file_manager_utils::GetModelsContainerPath().string() + "/" +
model_file + ".yaml");
commands::ModelStopCmd smc(config.apiServerHost,
std::stoi(config.apiServerPort),
yaml_handler.GetModelConfig());
smc.Exec();
});

auto embeddings_cmd = app_.add_subcommand(
"embeddings", "Creates an embedding vector representing the input text");
auto list_models_cmd =
models_cmd->add_subcommand("list", "List all models locally");
list_models_cmd->callback([]() { commands::ModelListCmd().Exec(); });

auto get_models_cmd =
models_cmd->add_subcommand("get", "Get info of {model_id} locally");
get_models_cmd->add_option("model_id", model_id, "");
get_models_cmd->require_option();
get_models_cmd->callback([&model_id]() {
commands::ModelGetCmd command(model_id);
command.Exec();
});

auto model_del_cmd =
models_cmd->add_subcommand("delete", "Delete a model by ID locally");
model_del_cmd->add_option("model_id", model_id, "");
model_del_cmd->require_option();
model_del_cmd->callback([&model_id]() {
commands::ModelDelCmd mdc;
mdc.Exec(model_id);
});

auto model_update_cmd =
models_cmd->add_subcommand("update", "Update configuration of a model");

// Default version is latest
std::string version{"latest"};
{ // engines group commands
auto engines_cmd = app_.add_subcommand("engines", "Get cortex engines");
auto list_engines_cmd =
engines_cmd->add_subcommand("list", "List all cortex engines");
list_engines_cmd->callback([]() {
commands::EngineListCmd command;
command.Exec();
});

auto install_cmd = engines_cmd->add_subcommand("install", "Install engine");
for (auto& engine : engine_service_.kSupportEngines) {
std::string engine_name{engine};
EngineInstall(install_cmd, engine_name, version);
}

auto uninstall_cmd =
engines_cmd->add_subcommand("uninstall", "Uninstall engine");
for (auto& engine : engine_service_.kSupportEngines) {
std::string engine_name{engine};
EngineUninstall(uninstall_cmd, engine_name);
}
// engines group commands
auto engines_cmd =
app_.add_subcommand("engines", "Subcommands for managing engines");
engines_cmd->group(kEngineGroup);
engines_cmd->require_subcommand();

auto list_engines_cmd =
engines_cmd->add_subcommand("list", "List all cortex engines");
list_engines_cmd->callback([]() {
commands::EngineListCmd command;
command.Exec();
});

EngineGet(engines_cmd);
auto install_cmd = engines_cmd->add_subcommand("install", "Install engine");
install_cmd->require_subcommand();
for (auto& engine : engine_service_.kSupportEngines) {
std::string engine_name{engine};
EngineInstall(install_cmd, engine_name, version);
}

{
// cortex run tinyllama:gguf
auto run_cmd =
app_.add_subcommand("run", "Shortcut to start a model and chat");
std::string model_id;
run_cmd->add_option("model_id", model_id, "");
run_cmd->callback([&model_id, &config] {
commands::RunCmd rc(config.apiServerHost, std::stoi(config.apiServerPort),
model_id);
rc.Exec();
});
auto uninstall_cmd =
engines_cmd->add_subcommand("uninstall", "Uninstall engine");
uninstall_cmd->require_subcommand();
for (auto& engine : engine_service_.kSupportEngines) {
std::string engine_name{engine};
EngineUninstall(uninstall_cmd, engine_name);
}

EngineGet(engines_cmd);

auto start_cmd = app_.add_subcommand("start", "Start the API server");
start_cmd->group(kSystemGroup);
int port = std::stoi(config.apiServerPort);
start_cmd->add_option("-p, --port", port, "Server port to listen");
start_cmd->callback([&config, &port] {
Expand All @@ -190,7 +204,7 @@ bool CommandLineParser::SetupCommand(int argc, char** argv) {
});

auto stop_cmd = app_.add_subcommand("stop", "Stop the API server");

stop_cmd->group(kSystemGroup);
stop_cmd->callback([&config] {
commands::ServerStopCmd ssc(config.apiServerHost,
std::stoi(config.apiServerPort));
Expand All @@ -211,17 +225,20 @@ bool CommandLineParser::SetupCommand(int argc, char** argv) {

std::string cortex_version;
bool check_update = true;
{
auto update_cmd = app_.add_subcommand("update", "Update cortex version");

update_cmd->add_option("-v", cortex_version, "");
update_cmd->callback([&cortex_version, &check_update] {
commands::CortexUpdCmd cuc;
cuc.Exec(cortex_version);
check_update = false;
});
}

auto update_cmd = app_.add_subcommand("update", "Update cortex version");
update_cmd->group(kSystemGroup);
update_cmd->add_option("-v", cortex_version, "");
update_cmd->callback([&cortex_version, &check_update] {
commands::CortexUpdCmd cuc;
cuc.Exec(cortex_version);
check_update = false;
});

auto ps_cmd =
app_.add_subcommand("ps", "Show running models and their status");
ps_cmd->group(kSystemGroup);

CLI11_PARSE(app_, argc, argv);
if (argc == 1) {
CLI_LOG(app_.help());
Expand Down Expand Up @@ -270,12 +287,14 @@ void CommandLineParser::EngineUninstall(CLI::App* parent,

void CommandLineParser::EngineGet(CLI::App* parent) {
auto get_cmd = parent->add_subcommand("get", "Get an engine info");
get_cmd->require_subcommand();

for (auto& engine : engine_service_.kSupportEngines) {
std::string engine_name{engine};
std::string desc = "Get " + engine_name + " status";

auto engine_get_cmd = get_cmd->add_subcommand(engine_name, desc);
engine_get_cmd->require_option();
engine_get_cmd->callback(
[engine_name] { commands::EngineGetCmd().Exec(engine_name); });
}
Expand Down