quickwit-oss / quickwit-oss/quickwit

Idea: CLI setup tool

Open
#2,597 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
11.7k
Forks
597
Avg merge
2d 22h
Merged PRs (30d)
37

Description

When you first start out with Quickwit, setup can be a bit intimidating with so many options!

What would be nice is if we had a CLI tool option like quickwit init and quickwit index init, etc... which walks you through all of the configurations in a bit more of a step-by-step process that then generates the required config file(s) at the end of it.

Something along the lines of how some tools like Python's poetry walk you through adding dependencies and generating a project when you initialise it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing Quickwit's existing CLI entry points and configuration format, then compare the proposed quickwit init and quickwit index init flows with current setup options. Define the interactive steps and generated configuration files before implementation; done means a newcomer can complete setup through the CLI and obtain usable config files.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.