Skip to content
This repository has been archived by the owner on Oct 24, 2018. It is now read-only.

Commit

Permalink
add some documentations for tracimcli tool
Browse files Browse the repository at this point in the history
  • Loading branch information
inkhey committed Apr 5, 2018
1 parent af0112f commit fe6d7a4
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Create configuration files for a development environment:

cp development.ini.base development.ini

Initialize the database.
Initialize the database using [tracimcli](doc/cli.md) tool

tracimcli db init

Expand Down
43 changes: 43 additions & 0 deletions doc/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## TracimCli ##

Tracim has a build-in command line tool.

## Introduction ##

This document is intended to developers or sysadmin.

In order to use the `tracimcli` commands, change your current directory to be `tracim/` from the root of the project, also usually named `tracim/`
and active the Tracim virtualenv:

user@host:~/tracim_backend$ cd tracim/
user@host:~/tracim_backend/tracim$ source env/bin/activate
(env) user@host:~/tracim_backend/tracim$

## Database ##

### Create database

tracim db init

## User ##

### add a user

tracimcli user create -l "john@john@john.john" -p "superpassword"

### update user password

tracimcli user update -l "john@john@john.john" -p "mynewsuperpassword"

### Help

tracim user create -h
tracim user update -h

## Help ##

tracimcli -h




0 comments on commit fe6d7a4

Please sign in to comment.