Command Line

When Kinto is installed, a command kinto becomes available.

It accepts a --ini parameter, whose default value is config/kinto.ini or the KINTO_INI env variable if defined.

A set of «sub commands» are available.

usage: kinto [-h] {init,start,migrate,version} ...

Kinto Command-Line Interface

optional arguments:
  -h, --help            show this help message and exit

subcommands:
  Main Kinto CLI commands

  {init,start,migrate,version}
                        Choose and run with --help

Configuration file

Creates a configuration file that works out of the box.

usage: kinto init [-h] [--backend BACKEND]

optional arguments:
  -h, --help         show this help message and exit
  --backend BACKEND  {memory,postgresql}

Note

When choosing postgresql, the PostgreSQL Python dependencies will be installed if not available.

Database schemas

Installs the last database schemas in the configured backends.

usage: kinto migrate [-h] [--dry-run]

optional arguments:
  -h, --help  show this help message and exit
  --dry-run   Simulate the migration operations and show information

Note

Running this on PostgreSQL requires the configured user to have certain privileges (table creation etc.).

Local server

Starts Kinto locally using a simple HTTP server.

usage: kinto start [-h] [--reload] [--port PORT]

optional arguments:
  -h, --help   show this help message and exit
  --reload     Restart when code or config changes
  --port PORT  Listening port number

Note

This not recommended for production. See more details.

Flush Cache

Clears the content of the cache backend. This can be useful for debugging.

usage: kinto flush-cache [--ini INI_FILE]

For example:

kinto flush-cache --ini kinto.ini

Purge Deleted

Delete tombstones from the database, and keep a certain number of them per collection.

This is not recommended in production, unless you really know what you are doing.

It will break partial synchronization on clients that didn’t have the chance to apply these deletions locally.

usage: kinto purge-deleted [-h] [--ini INI_FILE] [-q] [-v] resources [resources ...] max-retained

For example:

kinto purge-deleted --ini=config/postgresql.ini bucket collection record 10000