configuration & commands

This is a guide that covers config file directories and commands for the swell command line interface.

configuration

~/.swellrc

The main configuration file for swell.

~/.swell/swell.log

swell’s log file, (if enabled)

~/.swell/db/swell.db

swell’s database.

CLI

If you are familiar with the CLI, you can use swell from the command line instead of the GUI.

Once installed you can start swell from the command line by typing:

$ swell start

swell will start and run in the background and do it's magic.

type $ swell -h or man swell for more help on using swell's CLI.

Here is a list of s

setup

Setup swell.

This is required to get started with swell, You also need Flash to be able to use swell setup.

start

Starts the swell server

Optional arguments:

--no-server

Start swell with no http server.
--port

Start swell a custom port number.
--no-api

Disable swell API.
--no-color

Disable colors.
--http-port

Change port number for swell http server.
--basic | -b

Start swell in basic mode.
--log | -l

Start swell with logging enabled.
--log-file | -o

Log output to file (swell.log)
--confirm | -c

Automatically confirm action.
-h

Help menu.

stop

Stops the swell daemon.

ls

Lists currently tracked Flash files.

other commands

status

Shows the status of swell.

path

Displays the path to the current swell installation.

validate

Check swell database for issues.

rm

Removes a single project from swell.

reset

Resets swell to its default settings.

(This command is destructive. Use with caution.)

api

Swell has a REST API developers can play with.

In it's current implementation, the API is very basic and more features will be added to it.

In the meantime you can interact with the endpoints below.

Note: The GUI version of Swell has the REST API disabled by default. To access the API you must restart Swell with developer mode turned on.

/api/v1/projects

Method: GET

Lists all projects in swell.

/api/v1/projects/{name}/data