This repository has been archived by the owner on Oct 24, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add some documentations for tracimcli tool
- Loading branch information
Showing
2 changed files
with
44 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|
||
|
||
|