---
title: "Overview | skene Docs | Skene"
description: "A CLI toolkit for analyzing codebases through the lens of Product-Led Growth: mapping the customer journey encoded in your code and database schema."
url: https://www.skene.ai/resources/docs/skene/overview
doc_version: "56e87100436c"
last_updated: 2026-10-30
---

A CLI toolkit for analyzing codebases through the lens of Product-Led Growth (PLG): mapping the customer journey encoded in your code and database schema.

## What skene does

- **Maps the customer journey:** `analyse-journey` uses parallel code and schema agents to produce a `journey.yaml` of your product's user lifecycle
- **Maintains a feature registry:** persistent tracking of growth features across analysis runs with merge-update semantics
- **Pushes the Skene bundle upstream:** uploads files from the configured output directory plus the latest trigger migration to Skene Cloud
- **Validates engine/migration alignment:** `status` checks action-enabled engine features against generated SQL artifacts
- **Supports multiple LLM providers**: OpenAI, Gemini, Anthropic, LM Studio, Ollama, and any OpenAI-compatible endpoint

## Core workflow

```bash
# 1. Create a config file
uvx skene config --init

# 2. Set up your LLM provider and API key interactively
uvx skene config

# 3. Analyse your codebase and schema into a journey.yaml
uvx skene analyse-journey .

# 4. Login to Skene Cloud
uvx skene login

# 5. Push artifacts upstream
uvx skene push
```

## Key concepts

**Journey** (`journey.yaml`): The only output of the `analyse-journey` command, written to `skene-context/journey.yaml`. A validated YAML map of your product's user lifecycle: parallel code and schema agents each propose candidate milestones, a deterministic merge reconciles them, and a classification pass places them across seven canonical lifecycle stages.

**Engine model** (`skene-context/engine.yaml`): A YAML model that captures subjects and features, including optional action definitions for trigger/runtime behavior.

**Feature registry** (`feature-registry.json`): A persistent registry of growth features that tracks features across analysis runs. Features are marked active or archived, linked to engine feature keys, and annotated with growth pillars (onboarding, engagement, retention).

**Skene API key:** A single key from Skene Cloud that manages all tokens required to use LLM models and authorizes pushing engine artifacts upstream. One key replaces per-provider API keys for LLM usage and enables cloud push. Get your key at https://www.skene.ai/workspace/apikeys

## Documentation

### Getting started

- [Installation](https://www.skene.ai/resources/docs/skene/getting-started/installation): Install via uvx, pip, or from source
- [Quickstart](https://www.skene.ai/resources/docs/skene): End-to-end walkthrough

### Guides

#### Create

- [Push](https://www.skene.ai/resources/docs/skene/guides/push): Pushing engine + trigger artifacts upstream

#### Manage

- [Login](https://www.skene.ai/resources/docs/skene/guides/login): Authenticating with Skene Cloud upstream
- [Status](https://www.skene.ai/resources/docs/skene/guides/status): Checking engine/migration implementation status
- [Features](https://www.skene.ai/resources/docs/skene/guides/features): Managing and exporting the feature registry
- [LLM providers](https://www.skene.ai/resources/docs/skene/guides/llm-providers): Configuring OpenAI, Gemini, Claude, local LLMs
- [Configuration](https://www.skene.ai/resources/docs/skene/guides/configuration): Config files, env vars, and priority

### Integrations

- [MCP server](https://www.skene.ai/resources/docs/cloud/integrations/mcp): Using skene with AI assistants

### Reference

- [CLI reference](https://www.skene.ai/resources/docs/skene/reference/cli): All commands and flags
- [HTTP API](https://www.skene.ai/resources/docs/skene/reference/http-api): Status of the unsupported local server interface and supported alternatives
- [Python API](https://www.skene.ai/resources/docs/skene/reference/python-api): CodebaseExplorer, journey models, schemas

### Help

- [Troubleshooting](https://www.skene.ai/resources/docs/skene/troubleshooting): LM Studio, Ollama, common errors

### Hosted product

- [Skene Cloud](https://www.skene.ai/resources/docs/cloud): Dashboard, Supabase connection, schema analysis, feature deploy, and logs (no CLI required for the full in-browser flow)

## Sitemap

- [Markdown sitemap](https://www.skene.ai/sitemap.md): every page on this site, with its markdown counterpart.
- [Index for language models](https://www.skene.ai/llms.txt): the same set as a link-dense index.
- [Full corpus](https://www.skene.ai/llms-full.txt): reference content concatenated as plain text.
