Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Minor CLI improvements #140

Merged
merged 3 commits into from
Nov 6, 2023
Merged

Minor CLI improvements #140

merged 3 commits into from
Nov 6, 2023

Conversation

igiloh-pinecone
Copy link
Contributor

  1. Rename service to server in CLI prints and help messages
  2. Added explicit order of subcommands in canopy --help, which matches the Quick Start order: 
     >canopy -h
Usage: canopy [OPTIONS] COMMAND [ARGS]...

...

Commands:
  new       Create a new Pinecone index that that will be used by Canopy.
  upsert    Upload local data files to the Canopy service.
  start     Start the Canopy server.
  chat      Debugging tool for chatting with the Canopy RAG service.
  health    Check if canopy server is running and healthy.
  stop      Stop the Canopy server.
  api-docs  Open the Canopy Server docs

@igiloh-pinecone
[CLI] Control commands order in help message
3e63f95 
This way, running 'canopy --help' prints the errors in the order matching the quick start
@igiloh-pinecone
[cli] Rename 'service' to 'server'
3f8acd2 
This conforms with the naming we use in the documentation
miararoy
miararoy approved these changes Nov 5, 2023
View reviewed changes
Copy link
Contributor

@miararoy miararoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lg

src/canopy_cli/cli.py
@@ -131,7 +131,29 @@ def _load_kb_config(config_file: Optional[str]) -> Dict[str, Any]:
return kb_config


@click.group(invoke_without_command=True, context_settings=CONTEXT_SETTINGS)
class CanopyCommandGroup(click.Group):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition

@review-notebook-app Review Notebook App
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@igiloh-pinecone igiloh-pinecone merged commit 4e7a2ce into server-docstrings Nov 6, 2023
10 checks passed
@igiloh-pinecone igiloh-pinecone deleted the cli_server branch November 6, 2023 09:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@miararoy miararoy miararoy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@igiloh-pinecone @miararoy