Getting Started

The Getting Started section will walk you through the process of setting up and running Lumentis, the AI-powered documentation tool. Lumentis is designed to make it easy to convert long-form text into well-structured, visually appealing documentation.

In this section, we'll cover the key steps to get you up and running with Lumentis, including installation, configuration, and running the tool. Let's dive in!

Installation

To get started with Lumentis, you'll first need to install it on your system. Lumentis is built using Node.js, so you'll need to have that installed on your machine. You can download the latest version of Node.js from the official website: https://nodejs.org/en/download/ (opens in a new tab).

Once you have Node.js installed, you can install Lumentis using npm, the Node.js package manager. Open a terminal or command prompt and run the following command:

npm install -g lumentis

This will install the Lumentis package globally on your system, making it available for use.

Configuration

Before you can start using Lumentis, you'll need to configure a few settings. The most important configuration is setting up your Anthropic API key, which is required for Lumentis to access the language model for generating your documentation.

You can set the Anthropic API key in one of two ways:

1. Environment Variable: Add the API key as an environment variable named ANTHROPIC_API_KEY on your system.
2. Prompt: When you run Lumentis, you'll be prompted to enter the API key.

Once you've set the API key, you can customize other settings, such as the AI model to use, whether to stream output to the console, and the location where Lumentis should save its files.

Running Lumentis

With Lumentis installed and configured, you're ready to start generating documentation. To run Lumentis, open a terminal or command prompt and enter the following command:

lumentis

This will start the Lumentis wizard, which will guide you through the process of generating your documentation. The wizard will prompt you for the following information:

• Primary source file or folder
• AI model to use for meta-inference (e.g., outline generation)
• AI model to use for page generation
• Additional settings, such as whether to stream output to the console

After you've provided the necessary information, Lumentis will generate the documentation for you, including an outline and individual pages. The generated documentation will be saved in the pages directory of your current working directory, which you can then use with a static site generator like Nextra to publish your documentation online.

That's the basic overview of getting started with Lumentis. For more advanced topics, such as customizing prompts, integrating with other tools, and troubleshooting, please refer to the other sections in this documentation.