Skip to content

Commit 02ef0ec

Browse files
committed
Add macOS command-line instructions AzureCosmosDB#30
1 parent ffa23ee commit 02ef0ec

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ This tutorial outlines how to use the Azure Cosmos DB Desktop Data Migration Too
160160

161161
## Using the command line
162162

163-
1. Ensure the project is [built](#build-the-solution).
163+
1. Download the latest [release](https://github.com/AzureCosmosDB/data-migration-desktop-tool/releases), or ensure the project is [built](#build-the-solution).
164164

165-
2. The **Extensions** folder contains the plug-ins available for use in the migration. Each extension is located in a folder with the name of the data source. For example, the Cosmos DB extension is located in the folder **Cosmos**. Before running the application, you can open the **Extensions** folder and remove any folders for the extensions that are not required for the migration.
165+
2. The **Extensions** folder contains the [plug-ins available](#extension-documentation) for use in the migration. Each extension is located in a folder with the name of the data source. For example, the Cosmos DB extension is located in the folder **Cosmos**. Before running the application, you can open the **Extensions** folder and remove any folders for the extensions that are not required for the migration.
166166

167167
3. In the root of the build folder, locate the **migrationsettings.json** and update settings as documented in the [Extension documentation](#extension-documentation). Example file (similar to tutorial above):
168168

@@ -183,14 +183,27 @@ This tutorial outlines how to use the Azure Cosmos DB Desktop Data Migration Too
183183
}
184184
}
185185
```
186+
186187
> **Note**: **migrationsettings.json** can also be configured to execute multiple data transfer operations with a single run command. To do this, include an `Operations` property consisting of an array of objects that include `SourceSettings` and `SinkSettings` properties using the same format as those shown above for single operations. Additional details and examples can be found in [this blog post](https://codemindinterface.com/2023/03/cosmos-tool-operations/).
187-
188+
188189
4. Execute the program using the following command:
189190

191+
**Using Windows**
192+
190193
```bash
194+
// Windows
191195
dmt.exe
192196
```
193-
> **Note**: Use the `--settings` option with a file path to specify a different settings file (overriding the default **migrationsettings.json** file). This facilitates automating running of different migration jobs in a programmatic loop.
197+
198+
> **Note**: Use the `--settings` option with a file path to specify a different settings file (overriding the default **migrationsettings.json** file). This facilitates automating running of different migration jobs in a programmatic loop.
199+
200+
**Using macOS**
201+
202+
```bash
203+
./dmt
204+
```
205+
206+
> **Note**: Before you run the tool on macOS, you'll need to follow Apple's instructions on how to [Open a Mac app from an unidentified developer](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).
194207

195208
## Creating Extensions
196209

0 commit comments

Comments
 (0)