Welcome to twtxt!

Release: v1.3.2-dev.

Welcome to twtxt’s documentation. This documentation is divided into multiple parts. We recommend you to get started with the Installation and then head over to the Quickstart section. If you don’t know what this is about read the Introduction first. There is a more detailed Usage section about how to use twtxt via the CLI. The internals of twtxt are documented in the API chapter.

Feel free to contribute to this project. The source code is maintained on GitHub.

User Guide

• Introduction
  • Demonstration
  • Features
• Installation
  • Release version
  • Development version
• Quickstart
• Usage
  • Follow a source
  • List all sources you’re following
  • Unfollow a source
  • Post a status update
  • View your timeline
  • View feed of specific source
  • Edit twtxt configuration
• Configuration
  • [twtxt]
  • [followings]
• twtxt file
  • Format specification
• Registry
  • Format specification
  • API Endpoints
  • Add new User
  • Latest tweets
  • Search for tweets
  • Query for mentions
  • Query for tags
  • Query for users
• Discoverability

Community

• twtxt IRC channel: #twtxt on irc.libera.chat

API Reference

This part of the documentation describes the modules, classes, functions and other source code specific details of twtxt.

• API
  • Models
  • Config