Skip to content

Commit 86ded92

Browse files
committed
docs: reduced installation recommendations
1 parent 3e8d82c commit 86ded92

1 file changed

Lines changed: 11 additions & 23 deletions

File tree

packages/cli/README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,27 @@ Command-line interface for interacting with Bucket services. The CLI allows you
44
features, authentication, and generate TypeScript types for your Bucket features. With this tool,
55
you can streamline your feature flagging workflow directly from your terminal.
66

7-
## Quick Start
7+
## Usage
88

9-
Get started quickly by running the CLI directly without installing it from your project's root directory:
10-
initializing the CLI (if not already setup), creating a feature, and generate the types all at once.
11-
12-
```bash
13-
# Initialize CLI (if not already setup), create a feature, and generate types all at once
14-
npx @bucketco/cli new
15-
```
16-
17-
or install it locally and run it using the bin alias:
9+
Get started by installing the CLI locally in your project:
1810

1911
```bash
2012
# npm
2113
npm install --save-dev @bucketco/cli
2214

23-
npx bucket new
24-
2515
# yarn
2616
yarn add --dev @bucketco/cli
27-
28-
yarn bucket new
2917
```
3018

31-
### Global installation
32-
33-
You can also install the CLI globally adding the it to your PATH allowing you to use the shorthand `bucket`,
34-
but we recommend installing it locally instead to better maintain the version.
19+
Then running the `new` command from your project's root directory,
20+
initializing the CLI, creating a feature, and generating the types all at once:
3521

3622
```bash
37-
npm install -g @bucketco/cli
23+
# npm
24+
npx bucket new
3825

39-
bucket <command>
26+
# yarn
27+
yarn bucket new
4028
```
4129

4230
### Individual commands
@@ -45,13 +33,13 @@ Instead of running `new` you can call each step individually.
4533

4634
```bash
4735
# Initialize Bucket in your project (if not already setup)
48-
bucket init
36+
npx bucket init
4937

5038
# Create a new feature
51-
bucket features create "My Feature"
39+
npx bucket features create "My Feature"
5240

5341
# Generate TypeScript types for your features
54-
bucket features types
42+
npx bucket features types
5543
```
5644

5745
## Configuration

0 commit comments

Comments
 (0)