feat: create standalone CLI for cocoindex #485
Merged
Conversation
This file contains hidden or 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
|
Really awesome! Thanks for making this happen! |
badmonster0
reviewed
May 14, 2025
badmonster0
reviewed
May 15, 2025
badmonster0
reviewed
May 16, 2025
There was a problem hiding this comment.
Another thing I just notice - which will be needed by migrating existing examples - is about loading of the .env files.
Previously they're loaded by examples' main module (under the if __name__ == "__main__": condition), but they're no longer executed when we invoke this standalone CLI.
So I think this standalone CLI may need to be able to load .env file, and we may also add a --env_file flag to allow override (example: flask CLI is doing the similar).
Let me know if you have any other thoughts. Thanks!
|
Nice catch! |
badmonster0
reviewed
May 19, 2025
badmonster0
approved these changes
May 20, 2025
|
Thanks for all the help along the way! I've created another PR accounting for the docs' changes to the standalone CLI. |
chardoncs
pushed a commit
to chardoncs/cocoindex
that referenced
this pull request
May 21, 2025
* feat(flow): update text label to handle empty lines instead of color style * feat: update to use standalone cocoindex cli * feat: pass in `<module_path>:<flow_name>` directly in new CLI * feat: only show relevant flows given ls targets * feat: add function to parse app target and warn on flow name usage * feat: add support for loading dot-env files * feat: use `find_dotenv` for better path resolution
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.
This is a breaking change, and may resolve #417.
We create a standalone CLI for cocoindex. For compatibility reasons, we mark
main_fnas deprecated. So, users can still use@cocoindex.main_fn()in their programs, but when runningpython main.py cocoindex <command>, the deprecation warning will be shown instead.Now, in the new CLI, we will use
cocoindex <command> [options] --app main.pyto run the CLI program directly.A lot of examples and docs will then be outdated and need to be updated accordingly. I will start on those if all the changes in this PR are confirmed.