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

How to run moatless? #25

Open
zdaoguang opened this issue Jul 12, 2024 · 1 comment
Open

How to run moatless? #25

zdaoguang opened this issue Jul 12, 2024 · 1 comment

Comments

@zdaoguang
Copy link

Hi,

Thank you for your excellent work! I would like to request a detailed tutorial on how to run moatless. I am eager to use it but am having difficulty identifying the entry file. Could you please provide guidance on this?

Thank you very much!

@JensRoland
Copy link
Contributor

I don't believe there is an entry file as such, but a good starting point is the example Jupyter notebook, which can be run either under Google Colab or locally inside VS Code:

See https://github.com/aorwall/moatless-tools/blob/main/notebooks/00_index_and_run.ipynb

If you wanted to, you could refactor this into a CLI tool, though at this point I think a notebook makes more sense, since the indexing/embedding step isn't persisted/diffed, so in order to run consecutive instructions you'd either have to make it a REPL style CLI tool or implement persistence.

I'm sure this is going to happen in time, but for now, the notebook is good enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants