Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

discussion: --verbose flag #1261

Closed
0xSage opened this issue Sep 19, 2024 · 3 comments
Closed

discussion: --verbose flag #1261

0xSage opened this issue Sep 19, 2024 · 3 comments
Assignees
Labels
category: app shell Installer, updaters, distributions type: planning Opening up a discussion

Comments

@0xSage
Copy link
Contributor

0xSage commented Sep 19, 2024

Problem

Sometimes we want verbose logging when running commands

Questions

  1. Do users have to run --verbose for every command?
  2. Or is --verbose a toggle that turns on/off a verbosity setting?
  3. What is the intended UX of --verbose?
  4. Verbose will emit all of the logs that would otherwise write into /logs?

The current verbose stdout is quite hard to understand:

❯ sudo cortex-nightly --verbose
20240919 09:50:09.396980 UTC 3420791 INFO  Engine release path: https://delta.jan.ai/cortex/latest/version.json - cortex_upd_cmd.h:56
❯ sudo cortex-nightly --verbose engines list
20240919 09:50:25.655993 UTC 3420941 INFO  Config file name: .cortexrc-nightly - file_manager_utils.h:105
+---+--------------+-------------------+---------+--------------+
| # | Name         | Supported Formats | Version | Status       |
+---+--------------+-------------------+---------+--------------+
| 1 | ONNXRuntime  | ONNX              | 0.0.1   | Incompatible |
+---+--------------+-------------------+---------+--------------+
| 2 | llama.cpp    | GGUF              | 0.0.1   | Ready        |
+---+--------------+-------------------+---------+--------------+
| 3 | TensorRT-LLM | TensorRT Engines  | 0.0.1   | Incompatible |
+---+--------------+-------------------+---------+--------------+
20240919 09:50:25.660971 UTC 3420941 INFO  Engine release path: https://delta.jan.ai/cortex/latest/version.json - cortex_upd_cmd.h:56
@0xSage 0xSage added the type: planning Opening up a discussion label Sep 19, 2024
@0xSage 0xSage changed the title discuss: --verbose flag discussion: --verbose flag Sep 19, 2024
@0xSage 0xSage added the category: app shell Installer, updaters, distributions label Sep 19, 2024
@0xSage 0xSage moved this to Planning in Jan & Cortex Sep 19, 2024
@vansangpfiev
Copy link
Contributor

  1. Do users have to run --verbose for every command?
  2. Or is --verbose a toggle that turns on/off a verbosity setting?
    We have to run --verbose for each command. We don't save any state for CLI, so I think it does not make sense to turns on/off setting
  3. What is the intended UX of --verbose?
  4. Verbose will emit all of the logs that would otherwise write into /logs?
    The --verbose print all the LOG_INFO into the terminal, that will help user/dev to have more information when running a command

@0xSage
Copy link
Contributor Author

0xSage commented Sep 21, 2024

  1. Do users have to run --verbose for every command?
  2. Or is --verbose a toggle that turns on/off a verbosity setting?
    We have to run --verbose for each command. We don't save any state for CLI, so I think it does not make sense to turns on/off setting
  3. What is the intended UX of --verbose?
  4. Verbose will emit all of the logs that would otherwise write into /logs?
    The --verbose print all the LOG_INFO into the terminal, that will help user/dev to have more information when running a command

Is is just LOG_INFO? Or will it emit all levels of logs.

@dan-homebrew
Copy link
Contributor

dan-homebrew commented Sep 23, 2024

@0xSage I think --verbose is fairly standard across CLIs.

  • I think we should structure discussion around specific commands' --verbose
  • I don't think verbose is a setting
  • I would handle this later, after the basic stuff has been roughed in

@github-project-automation github-project-automation bot moved this from Planning to Completed in Jan & Cortex Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: app shell Installer, updaters, distributions type: planning Opening up a discussion
Projects
Archived in project
Development

No branches or pull requests

4 participants
@vansangpfiev @0xSage @dan-homebrew and others