README.md

Rethink

English | 简体中文

Rethink represents rethinking and is an AI (Large Language Model, LLM) based personal knowledge and cognitive growth assistant tool. Rethink will assist your knowledge and cognitive growth in the following two aspects:

1. Going beyond note-taking software, it automatically recommends and links existing knowledge and cognition when recording, building a more solid knowledge network;

2. AI knowledge expansion based on the LLM, allowing your cognition to continuously iterate and extend.

Main Features of Rethink

1. Personal Cognitive Growth Tool: Record and extend your thinking, assisting you in efficient growth;
2. AI Recommendation: AI knowledge expansion based on the large language model LLM, allowing your cognition to continuously iterate and extend;
3. Bidirectional Linking: Use @ linking or automatic recommendation to other notes;
4. Markdown Syntax: Seamless support for Markdown syntax;
5. Local Storage: Rethink highly values data security and provides a local deployment solution. In addition, there is an online version at https://rethink.run/r/login for synchronization between multiple platforms;
6. History Version Tracking: Supports history version tracking, making it easy to view and restore historical versions;

Installation and deployment methods:

• Deploy using Docker containerization
• Deploy using Python

Deploy using Docker containerization

Pull the image:

docker pull morvanzhou/rethink

Run the container:

To ensure data security, you should mount the local path to the container.

docker run \
 -p 8080:8080 \
 -v /your/data/path:/.data \
 morvanzhou/rethink

Now you can access http://127.0.0.1:8080 in your browser to use the service.

If you want to customize other ports, in addition to modifying the first half of the -p parameter, you also need to add an environment variable API_URL to redirect the API address in the frontend service: Make sure the port number in API_URL is consistent with the first half of the -p parameter (port 8001 in the following example).

docker run \
 -e API_URL=http://127.0.0.1:8081 \
 -p 8081:8080 \
 -v /your/data/path:/.data \
 morvanzhou/rethink

If you want to use Rethink authentication, you can add the environment variable APP_PASSWORD:

docker run \
 -e APP_PASSWORD=12345678 \
 -p 8080:8080 \
 -v /your/data/path:/.data \
 morvanzhou/rethink

All configurable environment variables:

• API_URL: API address in the frontend service, default is http://127.0.0.1:8080
• APP_PASSWORD: Authentication password, default is None
• APP_LANGUAGE: Language, default is English, optional values: zh, en

Deploy using Python

Install via pip

The second way to install and use Rethink is through pip installation. Then start the service directly with Python.

Initial installation:

pip install retk

Update:

pip install -U retk

Configure with Python

Use the retk.run() method to quickly start

Star History