Search by

psyao / kami

psyao

Psyao Kami: a Laravel and Filament CMS for developers, at home on shared hosting.

Package info

github.com/psyao/kami

pkg:composer/psyao/kami

Statistics

Installs: 165

Dependents: 1

Suggesters: 0

Stars: 0

Open Issues: 29

v0.10.0 2026-11-16 19:55 UTC

README

A Laravel and Filament CMS for developers, at home on shared hosting.

Psyao Kami, Kami for short, is a Composer package. Its admin is a plugin on your own Filament panel, and a site's content model is PHP code: Kami adds what a site needs without taking over the application. Everything runs on shared hosting with no cron, queue worker, Redis or Node on the server, and nothing essential depends on a remote service.

Kami is in early development: so far it covers installation, the environment check and the admin's wiring.

Requirements

  • PHP 8.5 or later, with the extensions listed in Installation
  • Laravel 13.32 or later and Filament 5.10.2 or later
  • SQLite, MySQL 8.4, MariaDB 10.11 or PostgreSQL 15 or later

Install

A new site starts from the starter kit:

laravel new site --using=psyao/kami-starter
cd site
php artisan kami:install
php artisan serve

kami:install asks for the first administrator, who signs in at /admin. To add Kami to an application you already have, see Existing application.

Documentation

  • Installation: requirements, creating a site, kami:doctor and kami:install
  • Existing application: adding Kami to a Laravel application and its panel
  • Content types: declaring a type and its Fields, writing and reading Entries
  • Blocks: declaring a Block, offering it in rich text, its modal, validation, References and view
  • Menus: declaring a Menu, its items, <x-kami::menu> with the Trail, Kami::menu() and the actions that write items
  • Redirects: the admin's Redirects page, SaveRedirect and DeleteRedirect, 301, 302 and 410, query-string sources and the Redirect model
  • Multilingual: Locales, Translations, Shared Fields and Fallback with lang
  • Publishing: Draft, Scheduled and Published, validation, slugs, Content events, and why SaveEntry does not authorise
  • Users and roles: KamiUser, Roles in config/kami.php, Permissions and strict authorization
  • Audit log: what Kami records, privacy, recording your own events with RecordAuditEvent, and batches
  • Routing and rendering: Kami::routes(), Paths, a type's render() and error pages (Kami::exceptions())
  • Front stacks: your own Livewire components and Inertia pages on both mounts, cached pages and the strict front policy
  • Page cache: what is cached and when it goes stale, Kami::withoutPageCache(), Kami::remember(), Kami::flushCache() and kami:cache:clear
  • SEO: the indexable switch (KAMI_INDEXABLE), X-Robots-Tag and the robots.txt kami:install writes
  • Security: the front and admin Content Security Policies, extending them, and the options that weaken them
  • Scheduler: Kami::schedule(), kami:tick, overdue tasks and a server's crontab
  • Forms: declaring a Form, its accessible markup, protection without a session, and Submissions
  • Imports: moving a running site's content into Kami with an app:import:<source> command, Legacy ids and replays
  • Hosting: what Kami needs from shared hosting and from a server
  • Deployment: the first deploy and every later one, on Infomaniak shared hosting or a server
  • Decision records: why Kami is built the way it is

Contributing to Kami itself: Development.

Licence

MIT, see LICENSE.md.