Discussion: Cortex.cpp CLI Syntax Convention

[freelerobot]

What is the syntax convention for our CLI?

CLI Syntax

1. Method names

• Follows OpenAI API: cortex models get
• Follows Docker: cortex models pull

2. The order of method vs required parameters

• cortex models set <param>
• cortex models <param> set

Command Chains

1. cortex run <model_id>: what sequence of calls does it make?
2. What other chaining do we have?
3. Do we automatically start engines based on the model?

[vansangpfiev]

What is the syntax convention for our CLI?

CLI Syntax

1. Method names

• Follows OpenAI API: cortex models get
• Follows Docker: cortex models pull

2. The order of method vs required parameters

• cortex models set <param>
• cortex models <param> set

Command Chains

1. cortex run <model_id>: what sequence of calls does it make?
2. What other chaining do we have?
3. Do we automatically start engines based on the model?

CLI Syntax

1. Method names

• Follows Docker: cortex models pull
• We also support cortex models get to get local model information that we have already pulled

2. The order of method vs required parameters

• cortex models set <param>

Command Chains

• cortex run <model_id>: what sequence of calls does it make?
  If model does not exist, pull model: cortex models pull <model_id>
  If engine does not exist, pull engine: cortex engines <engine_name> install
  Start model: cortex models start <model_id>
  Start chat: cortex chat <model_id> -m <msg>
• What other chaining do we have?
  We only have run command
• Do we automatically start engines based on the model?
  Yes, we do