Configuration files

Tessl uses two main configuration files that live in your project root:

👉 Closed beta notice

The full framework is currently part of Tessl’s closed beta program. You can request access here.

Project config

The tessl-config.jsonc file in your project directory contains structured configuration for your Tessl project. This file uses JSON with comments (JSONC) format.

You can manage your project config using tessl config commands in your project directory.

Schema

Property
Type
Description

name

string

Tile name

ciCommand

string[]

Commands to run for CI (optional)

Example

{
  "name": "my-tile",
  "ciCommand": ["npm run lint"],
}

Global config

The ~/.tessl/config.jsonc file in the home directory contains structured configuration for the Tessl CLI. This file uses JSON with comments (JSONC) format.

You can manage the project config using tessl config commands with the --global or -g flag in the project directory.

Schema

Property
Type
Description

shareUsageData

boolean

You can opt out of data sharing as explained in Sharing Usage Data by setting this to false (default: true)

Example

{
  "shareUsageData": true,
}

AGENTS.md

The AGENTS.md file provides project context to LLMs during code generation. This file is similar to CLAUDE.md and other context files.

After running tessl init, it will be updated to be structured into multiple sections. Some are managed by Tessl and are marked with <!-- tessl-managed -->.

As part of interacting with your agent while getting started with Tessl, context about the project stack, testing commands and the like will be automatically added. If you are not using a coding agent, add these yourself by replacing the "New Project Bootstrapping" section in AGENTS.md.

You are also free to add further details and context about your project as you would typically. The content of AGENTS.md and its links is automatically included in LLM prompts when generating code, helping ensure consistency with your project's patterns and conventions.

Purpose

  • Gives context to your agent about the Tessl framework

  • Defines your project's ecosystem and dependencies

  • Specifies coding conventions and patterns

  • Sets up project file layout expectations

Linking to Additional Files

AGENTS.md supports linking to other files in your project, and these linked files are automatically loaded and included in the LLM context during code generation. This allows you to modularize your project configuration and keep related information in separate files.

By default Tessl installs some modularized context in .tessl/system-prompt.

Use standard markdown link syntax to reference other files:

[link text](./relative/path/to/file.md)

Links should be relative paths from the file containing the link.

Last updated