You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The toolbar will automatically appear on `localhost`. However, it can also be incredibly useful in production.
280
+
You have full control over when it appears through the `toolbar` configuration option passed to the `BucketClient`.
281
+
282
+
You can pass a simple boolean to force the toolbar to appear/disappear:
283
+
284
+
```typescript
285
+
const client =newBucketClient({
286
+
// show the toolbar even in production if the user is an internal/admin user
287
+
toolbar: user?.isInternal,
288
+
...
289
+
});
290
+
```
291
+
292
+
You can also configure the position of the toolbar on the screen:
293
+
294
+
```typescript
295
+
const client =newBucketClient({
296
+
toolbar: {
297
+
show: true;
298
+
position: {
299
+
placement: "bottom-left",
300
+
offset: {x: "1rem", y: "1rem"}
301
+
}
302
+
}
303
+
...
304
+
})
305
+
```
306
+
307
+
See [the reference](https://docs.bucket.co/supported-languages/browser-sdk/globals#toolbaroptions) for details.
308
+
273
309
## Event listeners
274
310
275
311
Event listeners allow for capturing various events occurring in the `BucketClient`. This is useful to build integrations with other system or for various debugging purposes. There are 5 kinds of events:
@@ -290,7 +326,7 @@ const client = new BucketClient({
Copy file name to clipboardExpand all lines: packages/cli/README.md
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,16 @@
1
1
# Bucket CLI
2
2
3
-
Command-line interface for interacting with Bucket services. The CLI allows you to manage apps, features, authentication, and generate TypeScript types for your Bucket features. With this tool, you can streamline your feature flagging workflow directly from your terminal.
3
+
Command-line interface for interacting with Bucket services. The CLI allows you to manage apps,
4
+
features, authentication, and generate TypeScript types for your Bucket features. With this tool,
5
+
you can streamline your feature flagging workflow directly from your terminal.
4
6
5
7
## Quick Start
6
8
7
-
Get started quickly by running the CLI directly: initializing the CLI, creating a feature, and generate the types all at once.
9
+
Get started quickly by running the CLI directly from your project's root directory:
10
+
initializing the CLI (if not already setup), creating a feature, and generate the types all at once.
8
11
9
12
```bash
10
-
# Initialize CLI (if not setup), create a feature, and generate types all at once
13
+
# Initialize CLI (if not already setup), create a feature, and generate types all at once
11
14
npx @bucketco/cli new
12
15
```
13
16
@@ -33,7 +36,8 @@ yarn bucket new
33
36
34
37
### Global installation
35
38
36
-
You can also install the CLI globally adding the it to your PATH allowing you to use the shorthand `bucket`
39
+
You can also install the CLI globally adding the it to your PATH allowing you to use the shorthand `bucket`,
40
+
but we recommend installing it locally instead to better maintain the version.
37
41
38
42
```bash
39
43
npm install -g @bucketco/cli
@@ -58,7 +62,8 @@ bucket features types
58
62
59
63
## Configuration
60
64
61
-
The CLI creates a `bucket.config.json` file in your project directory when you run `bucket init`. This file contains all the necessary settings for your Bucket integration.
65
+
The CLI creates a `bucket.config.json` file in your project directory when you run `bucket init`.
66
+
This file contains all the necessary settings for your Bucket integration.
62
67
63
68
### Configuration File Structure
64
69
@@ -95,7 +100,8 @@ You can override these settings using command-line options for individual comman
95
100
96
101
### `bucket init`
97
102
98
-
Initialize a new Bucket configuration in your project. This creates a `bucket.config.json` file with your settings and prompts for any required information not provided via options.
103
+
Initialize a new Bucket configuration in your project.
104
+
This creates a `bucket.config.json` file with your settings and prompts for any required information not provided via options.
99
105
100
106
```bash
101
107
bucket init [--overwrite]
@@ -109,7 +115,8 @@ Options:
109
115
110
116
### `bucket new [featureName]`
111
117
112
-
All-in-one command to get started quickly. This command combines `init`, feature creation, and type generation in a single step. Use this for the fastest way to get up and running with Bucket.
118
+
All-in-one command to get started quickly. This command combines `init`, feature creation,
119
+
and type generation in a single step. Use this for the fastest way to get up and running with Bucket.
113
120
114
121
```bash
115
122
bucket new "My Feature" [--key my-feature] [--app-id ap123456789] [--key-format custom] [--out gen/features.ts] [--format react]
@@ -147,7 +154,8 @@ Manage your Bucket features with the following subcommands.
147
154
148
155
#### `bucket features create [featureName]`
149
156
150
-
Create a new feature in your Bucket app. The command guides you through the feature creation process with interactive prompts if options are not provided.
157
+
Create a new feature in your Bucket app.
158
+
The command guides you through the feature creation process with interactive prompts if options are not provided.
151
159
152
160
```bash
153
161
bucket features create "My Feature" [--key my-feature] [--app-id ap123456789] [--key-format custom]
@@ -161,7 +169,8 @@ Options:
161
169
162
170
#### `bucket features list`
163
171
164
-
List all features for the current app. This helps you visualize what features are available and their current configurations.
172
+
List all features for the current app.
173
+
This helps you visualize what features are available and their current configurations.
165
174
166
175
```bash
167
176
bucket features list [--app-id ap123456789]
@@ -173,7 +182,8 @@ Options:
173
182
174
183
#### `bucket features types`
175
184
176
-
Generate TypeScript types for your features. This ensures type safety when using Bucket features in your TypeScript/JavaScript applications.
185
+
Generate TypeScript types for your features.
186
+
This ensures type safety when using Bucket features in your TypeScript/JavaScript applications.
177
187
178
188
```bash
179
189
bucket features types [--app-id ap123456789] [--out gen/features.ts] [--format react]
0 commit comments