Docs
There are no docs yet.
The documentation is not public yet, because the software is not public yet. Here is what it will cover. If you have a question before then, ask it and we will answer it properly.
Planned
What the documentation will cover.
Everything in this list is planned and not written. Each part describes something that already exists in the product, so it is a table of contents rather than a wish list, but none of it is published and there is no date attached to any of it.
- Planned Getting it running
- Installing it on a supported machine, the configuration template, adding a first source, and what a healthy first index looks like.
- Planned The command reference
- Every command, every argument, the shape of the answer, and the error cases.
- Planned The HTTP API
- The published machine readable specification, key scopes and expiry, and how this surface differs from the agent one.
- Planned Sources
- Every kind of source it can index, and what to expect from each.
- Planned Access control and audit
- What the access model covers, how to set it up, and what the record of activity holds.
- Planned Running it
- Reindexing, updates, running more than one node, and what to do when a source goes wrong.
- Planned Writing your own connector
- How to index a kind of source we do not cover, in whatever language suits it. This is the one that matters most for coverage, and it is why the contract gets published rather than each connector getting built.
In the meantime
Ask the question directly.
A specific question gets a specific answer, from the person who built it, which is more use to you today than a manual for software you cannot run yet.
Write to rutvik@flareware.app. Tell us what you would want to point it at and what you would want to ask it.
The day the free edition is something you can download, this page becomes the documentation and "read the docs" becomes the first thing this site asks you to do.