PHPackages                             totalcms/totalcms - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. totalcms/totalcms

ActiveProject[Framework](/categories/framework)

totalcms/totalcms
=================

Total CMS - A modern flat-file content management system

3.5.0-beta.13(1w ago)258↑106.9%proprietaryPHPPHP >=8.2

Since Apr 16Pushed 1w ago1 watchersCompare

[ Source](https://github.com/totalcms/totalcms)[ Packagist](https://packagist.org/packages/totalcms/totalcms)[ RSS](/packages/totalcms-totalcms/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (1)Versions (7)Used By (0)

Total CMS
=========

[](#total-cms)

This is the project skeleton for [Total CMS](https://totalcms.co), a modern flat-file CMS for PHP.

Quick Start
-----------

[](#quick-start)

```
composer create-project totalcms/totalcms mysite
cd mysite
```

The installer will prompt you once Composer finishes:

1. **Layout** — `root` (T3 owns the whole domain) or `subpath` (T3 lives at `/tcms/`, leaving `public/` free for your own frontend build). Subpath reorganizes the front controller and rewrite rules automatically.
2. **Starter pack** (root layout only) — pick `none`, `minimal`, `blog`, `business`, or `portfolio`. Imports a Builder pack with sample pages, layouts, and seed content.
3. **Frontend asset pipeline** (root layout only) — copies a Vite-based bundle into `frontend/` so you can compile CSS/JS that builder layouts reference. Skip if you're bringing your own asset tooling.

Point your web server's document root to `public/`, then visit `/` (root) or `/tcms/` (subpath) — the setup wizard takes over from there.

### Non-interactive installs

[](#non-interactive-installs)

For CI or scripted setups, pre-answer with environment variables:

```
TCMS_LAYOUT=root \
TCMS_STARTER=blog \
TCMS_FRONTEND=1 \
  composer create-project totalcms/totalcms mysite
```

Defaults: `TCMS_LAYOUT=root`, `TCMS_STARTER=none`, `TCMS_FRONTEND=0`.

The installer self-destructs once it finishes, so to add a starter or the frontend pipeline after the fact, use the CLI directly:

```
vendor/bin/tcms builder:init blog    # install a starter
vendor/bin/tcms builder:frontend     # install the Vite frontend scaffold
```

Project Structure
-----------------

[](#project-structure)

```
mysite/
├── config/
│   └── tcms.php        # Your site configuration
├── public/
│   ├── .htaccess       # Front-controller rewrite rules (Apache)
│   └── index.php       # Web entry point
├── vendor/
│   └── totalcms/cms/   # Total CMS core (installed by Composer)
├── tcms-data/          # Content storage (created at runtime)
└── composer.json

```

Configuration
-------------

[](#configuration)

Edit `config/tcms.php` to override default settings:

```
return [
    'debug' => true,
    'datadir' => '/path/to/custom/tcms-data',
];
```

See the [Configuration Guide](https://docs.totalcms.co/getting-started/configuration) for all available options.

Documentation
-------------

[](#documentation)

- [Installation Guide](https://docs.totalcms.co/getting-started/installation)
- [Full Documentation](https://docs.totalcms.co)

Working with an AI agent
------------------------

[](#working-with-an-ai-agent)

This skeleton ships an [`AGENTS.md`](AGENTS.md) that orients AI coding assistants — the stack, project layout, the `tcms` CLI, conventions, and how to connect the Total CMS [MCP documentation server](https://mcp.totalcms.co/) so your assistant can look up exact Twig functions, field options, and API endpoints on demand.

`AGENTS.md` is read by many tools out of the box, but if yours expects a different filename just rename or copy it — for example `CLAUDE.md` (Claude Code), `GEMINI.md` (Gemini CLI), or a `.cursor/rules` file (Cursor). The content applies regardless of the filename.

License
-------

[](#license)

Total CMS is commercial software. See [LICENSE.md](https://github.com/totalcms/cms/blob/master/LICENSE.md) for terms.

Free 45-day trials are available at [totalcms.co](https://totalcms.co).

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance98

Actively maintained with recent releases

Popularity15

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~8 days

Total

6

Last Release

9d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/225628?v=4)[Joe Workman](/maintainers/joeworkman)[@joeworkman](https://github.com/joeworkman)

---

Top Contributors

[![joeworkman](https://avatars.githubusercontent.com/u/225628?v=4)](https://github.com/joeworkman "joeworkman (16 commits)")

---

Tags

cmscomposer-projectflat-filephptotalcms

### Embed Badge

![Health badge](/badges/totalcms-totalcms/health.svg)

```
[![Health](https://phpackages.com/badges/totalcms-totalcms/health.svg)](https://phpackages.com/packages/totalcms-totalcms)
```

###  Alternatives

[laravel/socialite

Laravel wrapper around OAuth 1 & OAuth 2 libraries.

5.7k104.3M822](/packages/laravel-socialite)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k38.6M289](/packages/laravel-dusk)[pinguo/php-msf

Pinguo Micro Service Framework For PHP

1.7k4.2k](/packages/pinguo-php-msf)[nineinchnick/edatatables

Grid widget for the Yii Framework, wrapper for the DataTables jQuery plugin

173.2k](/packages/nineinchnick-edatatables)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)