Skip to content

Adding config docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ajaymathur merged 4 commits into from
Feb 13, 2018
Merged

Adding config docs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6fda99
Adding config docs
sendilkumarn Feb 6, 2018
82e5d6f
moving it into single file
sendilkumarn Feb 7, 2018
4c19f05
fixing sidebars
sendilkumarn Feb 7, 2018
b7818b7
renaming the config into configurati
sendilkumarn Feb 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: config
title: bolt config
---

---

### **`bolt config delete <key>`**

Removes the given `key` from the config.

### **`bolt config list`**

Displays the current configuration.

### **`bolt config get <key>`**

Prints the value for a given `key`.

### **`bolt config set <key> <value> [-g|--global]`**

Sets the config `key` to the given `value`.

@ajaymathur ajaymathur Feb 12, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also add information that this will update yarn config

@sendilkumarn sendilkumarn Feb 12, 2018

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it makes sense to add it to all of them?

IMO, it is understandable and not needed. Just like what yarn does :)

4 changes: 3 additions & 1 deletion website/i18n/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"bolt": "bolt",
"build": "bolt build",
"check": "bolt check",
"config": "bolt config",
"doc": "bolt doc",
"format": "bolt format",
"init": "bolt init",
Expand All @@ -33,7 +34,8 @@
"About": "About",
"Commands": "Commands",
"Blog": "Blog",
"workspace": "workspace"
"workspace": "workspace",
"configuration": "configuration"
},
"pages-strings": {
"Help Translate|recruit community translators for your project": "Help Translate",
Expand Down
3 changes: 3 additions & 0 deletions website/sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
"workspace-run",
"workspace-exec",
"workspace-upgrade"
],
"configuration": [
"config"
]
}
}