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

Discussion: Cortex.cpp CLI Syntax Convention #1093

Closed

Description

@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
  1. 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?

Activity

  1. moved this to Need Investigation in Menloon Sep 4, 2024
  2. changed the title [-]Discussion: Cortex CLI Syntax Convention[/-] [+]Discussion: Cortex.cpp CLI Syntax Convention[/+] on Sep 4, 2024
  3. vansangpfiev commented on Sep 5, 2024

    @vansangpfiev
    Contributor

    What is the syntax convention for our CLI?

    CLI Syntax

    1. Method names
    • Follows OpenAI API: cortex models get
    • Follows Docker: cortex models pull
    1. 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
    1. 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
  4. locked and limited conversation to collaborators on Sep 5, 2024
  5. converted this issue into a discussion #1109 on Sep 5, 2024
  6. moved this from Need Investigation to Completed in Menloon Sep 5, 2024
  7. moved this from Completed to Discontinued in Menloon Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions