@@ -65,17 +65,16 @@ vagrant up # This may take a little while on the first run
65
65
```
66
66
67
67
You can always run ` vagrant provision ` to reconfigure virtual machine.
68
- Provision will install required dependencies and latest version of nightly
68
+ Provision will install required dependencies and nightly rust compiler
69
69
into virtual machine. It will also configure lxc-container inside
70
70
virtual machine.
71
71
72
72
### CLI
73
73
74
74
Make sure you are running every listed command inside ` /vagrant ` directory
75
75
in virtual machine. You can connect to virtual machine with ` vagrant ssh ` and
76
- switch cwd with: ` cd /vagrant ` inside virtual machine.
76
+ switch current working directory with: ` cd /vagrant ` inside virtual machine.
77
77
78
- You can get a full list of commands with ` cargo run -- --help ` .
79
78
80
79
#### Starting web server
81
80
@@ -100,13 +99,13 @@ cargo run -- build crate <CRATE_NAME> <CRATE_VERSION>
100
99
cargo run -- build add-essential-files
101
100
102
101
103
- # Builds every crate adds them into database
102
+ # Builds every crate and adds them into database
104
103
# (beware: this may take months to finish)
105
104
cargo run -- build world
106
105
```
107
106
108
107
109
- #### Database operations
108
+ #### ` database ` subcommand
110
109
111
110
``` sh
112
111
# Initializes database. Currently, only creates tables in database.
@@ -120,22 +119,25 @@ cargo run -- database add-directory <DIRECTORY> [PREFIX]
120
119
# Updates github stats for crates.
121
120
# You need to set CRATESFYI_GITHUB_USERNAME, CRATESFYI_GITHUB_ACCESSTOKEN
122
121
# environment variables in order to run this command.
123
- # You can define them in ~/.cratesfyi.env file.
122
+ # You can set this environment variables in ~/.cratesfyi.env file.
124
123
cargo run -- database update-github-fields
125
124
126
125
127
126
# Updates search-index.
128
127
# daemon is running this command occasionally, and this command must be
129
- # run to update recent-version of a crate and search index.
128
+ # run to update recent-version of a crate index and search index.
130
129
# If you are having any trouble with accessing right version of a crate,
131
- # run this command.
130
+ # run this command. Otherwise it's not required.
132
131
cargo run -- database update-search-index
133
132
134
133
135
134
# Updates release activitiy chart
136
135
cargo run -- database update-release-activity
137
136
```
138
137
138
+ If you want to explore or edit database manually, you can connect database
139
+ with ` psql ` command.
140
+
139
141
140
142
#### ` doc ` subcommand
141
143
0 commit comments