Command-Line Utilities

Snipe-IT comes with several command-line utilities to allow system admins to easily manage certain aspects of their Snipe-IT installation.

These should not be run as root, and should always be run from the Snipe-IT project directory.

All built-in app commands will start with php artisan, for example:

php artisan cache:clear

INFO Application cache cleared successfully.

Snipe-IT Commands

Many of these tools are meant for one-time data correction/syncing, however be sure to read the documentation for each tool to fully understand what it does.

Additionally, some tools such as alerts and backups, and LDAP user syncing can be set to run on a cron individually, or through the scheduler.

To see a full list of Snipe-IT commands from the command-line, run:

# Get a list of Snipe-IT command-line utilities and what they do

php artisan snipeit --help

(... lots of output here...)

Laravel Built-In Commands

Laravel (the framework Snipe-IT is built on) comes with several built-in utilities that are worth knowing.

# Run database migrations to bring your schema up to date with your current Snipe-IT code

php artisan migrate

# Clears the Snipe-IT app cache

php artisan cache:clear

# Clears the Snipe-IT app config

php artisan config:clear

# Clears the Snipe-IT app's cached routes

php artisan route:clear

# Clears the Snipe-IT app view cache

php artisan view:clear

# Clears the Snipe-IT app compiled files

php artisan clear-compiled

# Puts Snipe-IT into maintenance mode

php artisan down

# Takes Snipe-IT out of maintenance mode

php artisan up

# Show mail configs

php artisan config:show mail

# Show database configs

php artisan config:show database

# Show app configs

php artisan config:show app

If things are acting funny in your Snipe-IT install, running the above commands will often clear up your issues.

Database Utilities

Snipe-IT (by way of Laravel) also provides some basic database utilities from the command line.

# Display information about the given database

php artisan db:show

# Display information about the given database table

php artisan db:table

Data-Destructive Commands

These are available but should generally not be run unless you're willing to lose all of your data.

# Opens a cli to the database configured in your .env - USE WITH CAUTION

php artisan db

# Seed the database with dummy records - THIS WILL DESTROY YOUR EXISTING DATA!

php artisan db:seed

# Drop all tables, views, and types - THIS WILL DESTROY YOUR EXISTING DATA!

php artisan db:wipe