@bitwarden/cli 1.22.0 → 2022.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -56
- package/build/bw.js +1201 -815
- package/build/bw.js.map +1 -1
- package/build/locales/en/messages.json +3 -0
- package/package.json +5 -69
- package/LICENSE.txt +0 -674
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[](https://github.com/bitwarden/clients/actions/workflows/build-cli.yml?query=branch:master)
|
|
2
2
|
[](https://gitter.im/bitwarden/Lobby)
|
|
3
3
|
|
|
4
4
|
# Bitwarden Command-line Interface
|
|
@@ -9,7 +9,13 @@ The Bitwarden CLI is a powerful, full-featured command-line interface (CLI) tool
|
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Developer Documentation
|
|
13
|
+
|
|
14
|
+
Please refer to the [CLI section](https://contributing.bitwarden.com/clients/cli/) of the [Contributing Documentation](https://contributing.bitwarden.com/) for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.
|
|
15
|
+
|
|
16
|
+
## User Documentation
|
|
17
|
+
|
|
18
|
+
### Download/Install
|
|
13
19
|
|
|
14
20
|
You can install the Bitwarden CLI multiple different ways:
|
|
15
21
|
|
|
@@ -40,7 +46,7 @@ We provide natively packaged versions of the CLI for each platform which have no
|
|
|
40
46
|
sudo snap install bw
|
|
41
47
|
```
|
|
42
48
|
|
|
43
|
-
|
|
49
|
+
### Help Command
|
|
44
50
|
|
|
45
51
|
The Bitwarden CLI is self-documented with `--help` content and examples for every command. You should start exploring the CLI by using the global `--help` option:
|
|
46
52
|
|
|
@@ -57,58 +63,6 @@ bw list --help
|
|
|
57
63
|
bw create --help
|
|
58
64
|
```
|
|
59
65
|
|
|
60
|
-
|
|
66
|
+
### Help Center
|
|
61
67
|
|
|
62
68
|
We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.
|
|
63
|
-
|
|
64
|
-
## Build/Run
|
|
65
|
-
|
|
66
|
-
**Requirements**
|
|
67
|
-
|
|
68
|
-
- [Node.js](https://nodejs.org) v16.13.1.
|
|
69
|
-
- Testing is done against Node 16, other versions may work, but are not guaranteed.
|
|
70
|
-
- NPM v8
|
|
71
|
-
|
|
72
|
-
**Run the app**
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
npm install
|
|
76
|
-
npm run sub:init # initialize the git submodule for jslib
|
|
77
|
-
npm run build:watch
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
You can then run commands from the `./build` folder:
|
|
81
|
-
|
|
82
|
-
```bash
|
|
83
|
-
node ./build/bw.js login
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
## We're Hiring!
|
|
87
|
-
|
|
88
|
-
Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our [Careers page](https://bitwarden.com/careers/) to see what opportunities are currently open as well as what it's like to work at Bitwarden.
|
|
89
|
-
|
|
90
|
-
## Contribute
|
|
91
|
-
|
|
92
|
-
Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
|
|
93
|
-
|
|
94
|
-
Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the [`SECURITY.md`](SECURITY.md) file.
|
|
95
|
-
|
|
96
|
-
## Prettier
|
|
97
|
-
|
|
98
|
-
We recently migrated to using Prettier as code formatter. All previous branches will need to updated to avoid large merge conflicts using the following steps:
|
|
99
|
-
|
|
100
|
-
1. Check out your local Branch
|
|
101
|
-
2. Run `git merge ec53a16c005e0dd9aef6845c18811e8b14067168`
|
|
102
|
-
3. Resolve any merge conflicts, commit.
|
|
103
|
-
4. Run `npm run prettier`
|
|
104
|
-
5. Commit
|
|
105
|
-
6. Run `git merge -Xours 910b4a24e649f21acbf4da5b2d422b121d514bd5`
|
|
106
|
-
7. Push
|
|
107
|
-
|
|
108
|
-
### Git blame
|
|
109
|
-
|
|
110
|
-
We also recommend that you configure git to ignore the prettier revision using:
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
git config blame.ignoreRevsFile .git-blame-ignore-revs
|
|
114
|
-
```
|