@@ -65,17 +65,16 @@ vagrant up # This may take a little while on the first run
6565```
6666
6767You 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
6969into virtual machine. It will also configure lxc-container inside
7070virtual machine.
7171
7272### CLI
7373
7474Make sure you are running every listed command inside ` /vagrant ` directory
7575in 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.
7777
78- You can get a full list of commands with ` cargo run -- --help ` .
7978
8079#### Starting web server
8180
@@ -100,13 +99,13 @@ cargo run -- build crate <CRATE_NAME> <CRATE_VERSION>
10099cargo run -- build add-essential-files
101100
102101
103- # Builds every crate adds them into database
102+ # Builds every crate and adds them into database
104103# (beware: this may take months to finish)
105104cargo run -- build world
106105```
107106
108107
109- #### Database operations
108+ #### ` database ` subcommand
110109
111110``` sh
112111# Initializes database. Currently, only creates tables in database.
@@ -120,22 +119,25 @@ cargo run -- database add-directory <DIRECTORY> [PREFIX]
120119# Updates github stats for crates.
121120# You need to set CRATESFYI_GITHUB_USERNAME, CRATESFYI_GITHUB_ACCESSTOKEN
122121# 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.
124123cargo run -- database update-github-fields
125124
126125
127126# Updates search-index.
128127# 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.
130129# 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.
132131cargo run -- database update-search-index
133132
134133
135134# Updates release activitiy chart
136135cargo run -- database update-release-activity
137136```
138137
138+ If you want to explore or edit database manually, you can connect database
139+ with ` psql ` command.
140+
139141
140142#### ` doc ` subcommand
141143
0 commit comments