Просмотр исходного кода

add some documentations for tracimcli tool

Guénaël Muller 6 лет назад
Родитель
Сommit
fe6d7a424e
2 измененных файлов: 44 добавлений и 1 удалений
  1. 1 1
      README.md
  2. 43 0
      doc/cli.md

+ 1 - 1
README.md Просмотреть файл

@@ -44,7 +44,7 @@ Create configuration files for a development environment:
44 44
 
45 45
     cp development.ini.base development.ini
46 46
 
47
-Initialize the database.
47
+Initialize the database using [tracimcli](doc/cli.md) tool
48 48
 
49 49
     tracimcli db init
50 50
 

+ 43 - 0
doc/cli.md Просмотреть файл

@@ -0,0 +1,43 @@
1
+## TracimCli ##
2
+
3
+Tracim has a build-in command line tool.
4
+
5
+## Introduction ##
6
+
7
+This document is intended to developers or sysadmin.
8
+
9
+In order to use the `tracimcli` commands, change your current directory to be `tracim/` from the root of the project, also usually named `tracim/` 
10
+and active the Tracim virtualenv:
11
+
12
+    user@host:~/tracim_backend$ cd tracim/
13
+    user@host:~/tracim_backend/tracim$ source env/bin/activate
14
+    (env) user@host:~/tracim_backend/tracim$
15
+
16
+## Database ##
17
+
18
+### Create database
19
+
20
+    tracim db init
21
+
22
+## User ##
23
+   
24
+### add a user
25
+
26
+    tracimcli user create -l "john@john@john.john" -p "superpassword"
27
+
28
+### update user password
29
+
30
+    tracimcli user update -l "john@john@john.john" -p "mynewsuperpassword"
31
+
32
+### Help
33
+
34
+    tracim user create -h
35
+    tracim user update -h
36
+ 
37
+## Help ##
38
+
39
+    tracimcli -h
40
+    
41
+
42
+
43
+