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
Copy file name to clipboardExpand all lines: docs/docs/docs/cli/brownfield.mdx
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,22 @@
1
1
# Usage with Brownfield package
2
2
3
-
The `brownie` CLI provides utilities for building & packaging artifacts for brownfield projects that use the `@callstack/react-native-brownfield` library.
3
+
The `brownfield` CLI provides utilities for building & packaging artifacts for brownfield projects that use the `@callstack/react-native-brownfield` library.
4
4
5
5
## Usage
6
6
7
7
```bash
8
-
brownie package:android --module-name :BrownfieldLib --variant release # Package AAR with BrownfieldLib module in release variant
9
-
brownie publish:android --module-name :BrownfieldLib # Publish all build variants of BrownfieldLib module to Maven local
10
-
brownie package:ios --scheme BrownfieldLib --configuration Release # Package XCFramework for BrownfieldLib scheme in Release configuration
11
-
brownie codegen --help # Show help
12
-
brownie --version # Show version
8
+
brownfield package:android --module-name :BrownfieldLib --variant release # Package AAR with BrownfieldLib module in release variant
9
+
brownfield publish:android --module-name :BrownfieldLib # Publish all build variants of BrownfieldLib module to Maven local
10
+
brownfield package:ios --scheme BrownfieldLib --configuration Release # Package XCFramework for BrownfieldLib scheme in Release configuration
11
+
brownfield codegen --help # Show help
12
+
brownfield --version # Show version
13
13
```
14
14
15
15
## iOS
16
16
17
17
### Build for iOS
18
18
19
-
Simply run `npx brownie package:ios` to create an XCFramework that you can later integrate into your native iOS app according to other instruction sections below.
19
+
Simply run `npx brownfield package:ios` to create an XCFramework that you can later integrate into your native iOS app according to other instruction sections below.
20
20
21
21
Available arguments:
22
22
@@ -39,12 +39,12 @@ Available arguments:
39
39
40
40
## Android
41
41
42
-
For Android, building happens in two steps: first, you build (`brownie package:android`) the AAR artifact(s) with your module, in the appropriate build variant(s), and then you `brownie publish:android` them to Maven local.
42
+
For Android, building happens in two steps: first, you build (`brownfield package:android`) the AAR artifact(s) with your module, in the appropriate build variant(s), and then you `brownfield publish:android` them to Maven local.
43
43
From there, native applications can consume your library from the local Maven repository.
44
44
45
45
### Build for Android
46
46
47
-
To build the artifact for Android without publishing, run `npx brownie package:android --module-name app`.
47
+
To build the artifact for Android without publishing, run `npx brownfield package:android --module-name app`.
48
48
49
49
Available arguments:
50
50
@@ -56,9 +56,9 @@ Available arguments:
56
56
57
57
### Publish locally for Android
58
58
59
-
To publish the `.aar`(s) built beforehand with `npx brownie publish:android` to Maven local, which will allow Gradle to be able to load it from Maven local repository, run:
59
+
To publish the `.aar`(s) built beforehand with `npx brownfield publish:android` to Maven local, which will allow Gradle to be able to load it from Maven local repository, run:
Copy file name to clipboardExpand all lines: docs/docs/docs/cli/introduction.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
@@ -1,11 +1,11 @@
1
1
# Unified brownfield CLI
2
2
3
-
React Native Brownfield comes with a batteries-included, all-in-one CLI tool called `brownie` that helps you build and publish your React Native app as a framework artifact for iOS (XCFramework) and Android (AAR).
3
+
The React Native Brownfield ecosystem comes with a batteries-included, all-in-one CLI tool called `brownfield` that helps you build and publish your React Native app as a framework artifact for iOS (XCFramework) and Android (AAR).
4
4
Additionally, it contains CLI utilities for other tools like the `@callstack/brownie` state management tool.
5
5
6
6
> ![NOTE]
7
-
> The `brownie` CLI is a unified tool serving both the needs of `@callstack/react-native-brownfield` and `@callstack/brownie` packages. The name `brownie` does not mean it is only meant for `@callstack/brownie` state management tool; it is the main CLI for React Native Brownfield as well.
8
-
> Technically, the CLI itself is encapsulated in the `@callstack/brownie-cli` package, which is a dependency of both `@callstack/react-native-brownfield` and `@callstack/brownie`. Therefore, installing either of the packages will bring the `brownie` CLI tool to your project.
7
+
> The `brownfield` CLI is a unified tool serving both the needs of `@callstack/react-native-brownfield` and `@callstack/brownie` packages. The name `brownfield` does not mean it is only meant for `@callstack/brownie` state management tool; it is the main CLI for React Native Brownfield as well.
8
+
> Technically, the CLI itself is encapsulated in the `@callstack/brownie-cli` package, which is a dependency of both `@callstack/react-native-brownfield` and `@callstack/brownie`. Therefore, installing either of the packages will bring the `brownfield` CLI tool to your project.
0 commit comments