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
> **Warning**: This feature is a work in progress and may be incomplete or subject to change. If you see an error or something that could be improved, please make a pull request. The link that documents this feature can be found at the bottom of the page.
8
8
9
-
While Extension.js natively supports browsers like Chrome, Edge, and Firefox, you can also run unsupported browsers by specifying the path to the browser binary using the `--chromiumBinary` or `--geckoBinary` flags. Additionally, you can add custom binary paths via the `extension.config.js` file for persistent configuration across runs.
9
+
While Extension.js natively supports browsers like Chrome, Edge, and Firefox, you can also run unsupported browsers by specifying the path to the browser binary using the `--chromium-binary` or `--gecko-binary` flags. Additionally, you can add custom binary paths via the `extension.config.js` file for persistent configuration across runs.
10
10
11
11
## How Does It Work?
12
12
13
-
If you need to run a browser that is not fully supported by Extension.js, you can specify the path to a custom browser binary using the `--chromiumBinary` or `--geckoBinary` flags. Extension.js will launch the specified browser binary with your extension loaded, allowing you to test your extension in a custom browser environment.
13
+
If you need to run a browser that is not fully supported by Extension.js, you can specify the path to a custom browser binary using the `--chromium-binary` or `--gecko-binary` flags. Extension.js will launch the specified browser binary with your extension loaded, allowing you to test your extension in a custom browser environment.
14
14
15
15
**Example Using CLI Flags:**
16
16
@@ -45,20 +45,20 @@ In these scenarios, the browser specified in the `--chromiumBinary` or `--geckoB
45
45
46
46
Here is a short list of browsers you can run using these binary flags, along with their official websites for reference:
Copy file name to clipboardExpand all lines: docs/en/docs/commands/dev.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,8 +52,8 @@ Below is a breakdown of the available flags for the `dev` command:
52
52
|`--polyfill`| Boolean | Enables compatibility for the `browser.*` API in Chromium-based browsers |`false`|
53
53
|`--profile`| Profile path | Specifies a path to a browser profile for testing |`default`|
54
54
|`-b, --browser`| Browser to run the extension | Specifies the browser to run (`chrome`, `edge`, `firefox`, `all`) |`"chrome"`|
55
-
|`--chromium-binary`| Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/unsupported.mdx)|`undefined`|
56
-
|`--gecko-binary`| Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/unsupported.mdx)|`undefined`|
55
+
|`--chromium-binary`| Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/running-other-browsers.mdx)|`undefined`|
56
+
|`--gecko-binary`| Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/running-other-browsers.mdx)|`undefined`|
57
57
|`--starting-url`| URL | Starting URL for testing with the extension |`chrome://newtab`|
58
58
|`--open`| Boolean | Whether or not to automatically open the browser upon starting dev |`true`|
59
59
@@ -127,5 +127,5 @@ Below is a breakdown of the available flags for the `dev` command:
127
127
## Next Steps
128
128
129
129
- Once development is complete, it's time to [build your extension](/docs/commands/build).
130
-
- Learn how to create features specific to a browser with the [browser-specific manifest fields](/docs/features/browser-fields).
131
-
- Use the `extension.config.js` file to [configure your extension](/docs/features/config).
130
+
- Learn how to create features specific to a browser with the [browser-specific manifest fields](/docs/features/browser-specific-fields).
131
+
- Use the `extension.config.js` file to [configure your extension](/docs/features/extension-configuration).
Copy file name to clipboardExpand all lines: docs/en/docs/commands/preview.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,8 +45,8 @@ In this example, the extension is created in the `path/to/my-extension` director
45
45
|[path or url]| The extension path or the remote extension URL | If a path is defined, previews the local extension. If a URL is provided, pulls the extension from remote source and previews it as a local extension |`process.cwd()`|
46
46
|`--profile`| Profile path | Specifies a path to a browser profile for testing |`default`|
47
47
|`-b, --browser`| Browser to run the extension | Specifies the browser to run (`chrome`, `edge`, `firefox`, `all`) |`"chrome"`|
48
-
|`--chromium-binary`| Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/unsupported.mdx)|`undefined`|
49
-
|`--gecko-binary`| Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/unsupported.mdx)|`undefined`|
48
+
|`--chromium-binary`| Path to the Chromium binary | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/running-other-browsers.mdx)|`undefined`|
49
+
|`--gecko-binary`| Path to the Gecko binary | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/running-other-browsers.mdx)|`undefined`|
50
50
|`--starting-url`| URL | Starting URL for testing with the extension |`chrome://newtab`|
51
51
52
52
## Examples
@@ -95,4 +95,4 @@ In this example, the extension is created in the `path/to/my-extension` director
95
95
## Next Steps
96
96
97
97
- Learn how to [build](/docs/commands/build) your extension.
98
-
- Use the `extension.config.js` file to [configure your extension](/docs/features/config).
98
+
- Use the `extension.config.js` file to [configure your extension](/docs/features/extension-configuration).
0 commit comments