Start without a repository¶

A first-time user does not need to prepare folders, YAML, schemas, or MkDocs manually.

Install QLens¶

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[docs,dev,ai,server,visual]"

Create a project interactively¶

qlens init my-research

The wizard asks for:

project name;
primary language;
first Research Space;
optional first question;
optional AI provider.

Then run:

cd my-research
qlens start

QLens builds the repository and opens NUR at http://127.0.0.1:8000/.

Non-interactive example¶

qlens init bismillah-research \
  --yes \
  --title "Bismillah Research" \
  --language bn \
  --research-title "বিসমিল্লাহ গবেষণা" \
  --question "বিসমিল্লাহতে بِ — বি কী সম্পর্ক প্রকাশ করে?" \
  --ai-provider mock

What is created¶

my-research/
├── .qlens-project.yml
├── mkdocs.yml
├── docs/
├── overrides/
├── schemas/
├── profiles/
├── workflows/
├── repository/
│   ├── objects/
│   ├── events/
│   ├── indexes/
│   └── registry/
└── generated/

The repository remains canonical, but beginners can work through NUR and guided commands without constructing it manually.