add cli doc #117
Merged
add cli doc #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| To check the details of a certain completions, use [`log10 completions get`](#log10-completions-get). | ||
| For instance, | ||
| ```bash | ||
| log10 completions get --id 497974e8-c1ed-4de7-90ab-8f104eb870te |
There was a problem hiding this comment.
Nit: should be consistent about the trailing "$"
nqn
reviewed
Mar 13, 2024
|
|
||
| ## CLI References | ||
|
|
||
| ### Completions |
There was a problem hiding this comment.
Good for now, but we may have to auto gen these in the future: https://stackoverflow.com/questions/57810659/automatically-generate-all-help-documentation-for-click-commands
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| @@ -0,0 +1,340 @@ | |||
| # CLI | |||
|
|
|||
| Use `log10` CLI to list and download the completions, feedback, and feedback task data at [log10.io](https://log10.io). | |||
There was a problem hiding this comment.
Suggested change
| Use `log10` CLI to list and download the completions, feedback, and feedback task data at [log10.io](https://log10.io). | |
| Use the `log10` CLI to list and download the completions, feedback, and feedback task data at [log10.io](https://log10.io). |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
|
|
||
| ## Get Started | ||
|
|
||
| Install log10-io python package (version >= 0.6.7) and [setup Log10](README.md#⚙️-setup) |
There was a problem hiding this comment.
Suggested change
| Install log10-io python package (version >= 0.6.7) and [setup Log10](README.md#⚙️-setup) | |
| Install the `log10-io` python package (version >= 0.6.7) and [setup Log10](README.md#⚙️-setup) |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
|
|
||
| Install log10-io python package (version >= 0.6.7) and [setup Log10](README.md#⚙️-setup) | ||
| ```bash | ||
| pip install log10-io |
There was a problem hiding this comment.
Suggested change
| pip install log10-io | |
| $ pip install log10-io |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| ```bash | ||
| $ log10 completions list --tags foo,bar --from 2024-2-1 --to 2024-2-29 | ||
| ``` | ||
| Output: |
There was a problem hiding this comment.
Suggested change
| Output: | |
| #### Output |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| 100%|███████████████████████████████████████████████████████████████████████████| 5/5 [00:03<00:00, 1.31it/s] | ||
| ``` | ||
|
|
||
| To check the details of a certain completions, use [`log10 completions get`](#log10-completions-get). |
There was a problem hiding this comment.
Suggested change
| To check the details of a certain completions, use [`log10 completions get`](#log10-completions-get). | |
| To retrieve details for a specific completion, use [`log10 completions get`](#log10-completions-get). |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| ``` | ||
|
|
||
| ### Feedback Tasks and Feedback | ||
| To start adding feedback, first you need to define a feedback task with [`log10 feedback-task create`](#log10-feedback-task-create). Then you can add feedback to a logged completions with [`log10 feedback create`](#log10-feedback-create). For more details, please refer to this [doc](https://log10.io/docs/feedback/feedback#add-feedback). |
There was a problem hiding this comment.
Suggested change
| To start adding feedback, first you need to define a feedback task with [`log10 feedback-task create`](#log10-feedback-task-create). Then you can add feedback to a logged completions with [`log10 feedback create`](#log10-feedback-create). For more details, please refer to this [doc](https://log10.io/docs/feedback/feedback#add-feedback). | |
| To start adding feedback, first you need to define a feedback task with [`log10 feedback-task create`](#log10-feedback-task-create). Then you can add feedback to a logged completions with [`log10 feedback create`](#log10-feedback-create). For more details, you can read more in [log10's user documentation](https://log10.io/docs/feedback/feedback#add-feedback). |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| │ 15a5e099-a56a-49d0-b488 │ 29 days ago │ emoji_feedback_task │ feedback │ Provide feedback using emojis │ | ||
| └─────────────────────────┴─────────────┴────────────────────────────────────────────┴────────────────────────────────────────────┴───────────────────────────────────────────────────┘ | ||
| ``` | ||
| and check the detail of a task with [`log10 feedback-task get --id`](#log10-feedback-task-get) |
There was a problem hiding this comment.
Suggested change
| and check the detail of a task with [`log10 feedback-task get --id`](#log10-feedback-task-get) | |
| and retrieve details about a specific task with [`log10 feedback-task get --id`](#log10-feedback-task-get) |
nqn
reviewed
Mar 13, 2024
cli_docs.md
Outdated
| To list and download your current feedback, use [`log10 feedback list`](#log10-feedback-list) and [`log10 feedback download`](#log10-feedback-download). | ||
| For instance you can list all feedback filtered by a feedback task `--task_id`: | ||
| ```bash | ||
| ❯ log10 feedback list --task_id 04405cbc-3420-4901-97b6 |
There was a problem hiding this comment.
Suggested change
| ❯ log10 feedback list --task_id 04405cbc-3420-4901-97b6 | |
| $ log10 feedback list --task_id 04405cbc-3420-4901-97b6 |
nqn
approved these changes
Mar 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.