findref 0.2.2

Find technical reference document in terminal.

---

Welcome to findref Documentation

findref is an interactive terminal app that can search tech documentation reference. It is Python, cross-platform, easy-to-install, and blazing fast.

Usage Example

# install (you need Python3.8+)
$ pip install findref

# enter the interactive terminal app
$ fr

Then you can follow the hint and enter your query to search, it support fuzzy search, ngram search (See 🚀 supported-dataset)

It will ask you to wait for building the search index for the first time. After that, it will be very fast to search.

The dataset will be updated automatically every 30 days. You can also use !~ followed by any query to force update the dataset. For example, if tf aws s3 bucket doesn’t give you result, you can use tf aws s3 bucket!~ to search again on the latest data.

Keyboard shortcuts:

• ⬆️: hit Ctrl + E or UP to move item selection up.

• ⏫: hit Ctrl + R to scroll item selection up.

• ⬇️: hit Ctrl + D or DOWN to move item selection down.

• ⏬: hit Ctrl + F to scroll item selection down.

• ⬅️: hit Ctrl + H or LEFT to move query input cursor to the left (this won’t work on Windows).

• ➡️: hit Ctrl + L or RIGHT to move query input cursor to the right.

• ⏪: hit Ctrl + G to move query input cursor to the previous word.

• ⏩: hit Ctrl + K to move query input cursor to the next word.

• ↩️: hit Ctrl + X to clear the query input.

• ◀️: hit BACKSPACE to delete query input backward.

• ▶️: hit DELETE to delete query input forward.

• 🌐: hit Enter to open the reference in web browser.

• ✅: hit Ctrl + A to copy the url to clipboard.

• 🔴: hit Ctrl + C to quit the app.

Request for New Dataset

You can create a new issue and add the new dataset label to request for a new dataset. Please leave your comments, show me the link to the dataset you want to add, and provide some sample query and matched url items and @MacHu-GWU (me).

Request for Enterprise Support

findref works for enterprise internal dataset too. If you want a customized version to support your enterprise internal dataset, please follow the instruction in this ticket, our team will contact you soon.

Supported Dataset

• 🚀 Airflow Reference

• 🚀 AWS CloudFormation Reference

• 🚀 AWS boto3 Python SDK Reference

• 🚀 AWS CDK Python Reference

• 🚀 AWS CDK TypeScript Reference

• 🚀 PySpark Reference

• 🚀 Pandas Reference

• 🚀 Terraform Reference

🚀 Airflow Reference

🚀 AWS CloudFormation Reference

todo

🚀 AWS boto3 Python SDK Reference

🚀 AWS CDK Python Reference

🚀 AWS CDK TypeScript Reference

🚀 PySpark Reference

🚀 Pandas Reference

todo

🚀 Terraform Reference

Support AWS, Azure, GCP.

Install

findref is released on PyPI, so all you need is to:

# you need Python3.8+
$ pip install findref

To upgrade to latest version:

$ pip install --upgrade findref