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

Retrieve documents from CALMHub in the CLI #887

Open
willosborne opened this issue Feb 6, 2025 · 1 comment
Open

Retrieve documents from CALMHub in the CLI #887

willosborne opened this issue Feb 6, 2025 · 1 comment
Assignees
Labels
calm-hub The Calm Hub Product cli

Comments

@willosborne
Copy link
Member

Feature Request

Description of Problem:

Currently the CLI can only work with the local filesystem, and doesn't talk to CALMHub.
There should be a mode where it's configured to point at a CALMHub instance and patterns, schemas, etc are retrieved with the REST API.

Note that this is only about pulling data - we should also consider how the CLI will be used to upload patterns, architectures, etc into CALMHub but this will come later.

Potential Solutions:

Refactor the SchemaDirectory to have two implementations - a file system implementation that is the same as what we have today, and one that uses CALMHub.

Add an option to pass the CALMHub URL. Also potentially add the option to configure this in an init/rc file in the user's home directory. For example, ~/.calm.json

@willosborne willosborne mentioned this issue Feb 6, 2025
4 tasks
@willosborne willosborne self-assigned this Feb 6, 2025
@willosborne willosborne added cli calm-hub The Calm Hub Product labels Feb 6, 2025
@willosborne
Copy link
Member Author

Currently I have a working spike of this for the generate command.
Some changes to the CALMHub REST API will need to be made, we are discussing these today on the Office Hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
calm-hub The Calm Hub Product cli
Projects
None yet
Development

No branches or pull requests

1 participant