-
Notifications
You must be signed in to change notification settings - Fork 41
1.1 Usage Python
Patrick Connelly edited this page Jul 25, 2017
·
11 revisions
This page will describe how to use the Python wrapper for Solenopsis once you have configured it.
solenopsis [flags] [command] [params]
| Flag | Description | |
|---|---|---|
| -h, --help | show this help message and exit | |
| -a | Absolute path should be used | |
| -r | Relative path should be used | |
| -d | Make the output very verbose | |
| -v | Make the output verbose | |
| -f | Force overwrite | |
| -t | Run all tests | |
| --solversion VERSION | Denote the version of Solenopsis to use. If not specified, 1.1 will be used | |
| --pkgdir DIR | Denote the directory to generate a folder based package.xml. If not specified, the current working directory will be used | |
| --gitshell | When performing a git-push or git-destructive-push, will shell into the OS to compute git status values | |
| --apiversion VERSION | Denotes the Salesforce API version to use | |
| --filecontains VALUE | If any file contains VALUE, those files will be used to push | |
| -e DEPENDENT, --env DEPENDENT | Change the dependent enviroment | |
| -m MASTER, --master MASTER | Change master enviroment | |
| -s PATH, --src PATH | Change the src path | |
| -l HOME, --home HOME | Change the local.home path | |
| -i SFIGNORE, --ignorefile SFIGNORE | Change the sfdcignore file | |
| --tmpdir TMPDIR | Change the temporary directory | |
| --maxpoll MAXPOLL | Change the maximum amount of time to poll SFDC | |
| --requestid REQUESTID | The ongoing request id to repoll for | |
| --checkonly | Will try to validate a deploy, and not do the deploy | |
| --logtype LOGTYPE | The log type to use | |
| --batchsize BATCHSIZE | The number of items to retrieve for multipart retrieves | |
| --types TYPE1,TYPE2 | The metadata types to retrieve | |
| --packagefile PACKAGEFILE | Fully qualified path to package.xml | |
| --dryrun | Do a dry run and do not actually preform the action | |
| --fast | Deploy using the Quick Deploy feature | |
| --antfile ANTFILE | The location to the ant-salesforce jar | |
| --dump-files | If the build.xml should be dumped to disk | |
| --show-passwords | Used in conjunction with --dump-files to show the passwords in cleartext in the build.xml | |
| --xsldir XSLDIR | Specifies where the xsls are stored to be applied | |
| --properties PROPERTIES | Specifies which properties file to use | |
| --testlevel TEST_LEVEL | Specifies tests to run | |
| --username USERNAME | Overrides the username to be used | |
| --password PASSWORD | Overrides the password to be used | |
| --token TOKEN | Overrides the token to be used | |
| --destructiveChangesFile FILE_PATH | Sets the destructive changes XML file path |
##Commands
| Command | Description |
|---|---|
| push | Pushes the entire DEPENDENT environment |
| destructive-push | Destructively pushes the entire DEPENDENT environment |
| git-destructive-push | Destructively pushes what has changed in git |
| cached-destructive-push | Destructively pushes the DEPENDENT environment without refreshing the local cache |
| git-push | Pushes to the files that have changed in git |
| pull-full | Pulls from the DEPENDENT environment using members in package.xml that support the asterisk notation. |
| pull-full-to-master | Pulls from the DEPENDENT environment to the MASTER environment. For members in package.xml that do not support the asterisk notation, the master's files will be denoted appropriately. These include dashboard, documents, email and reports. |
| pull | Pulls from the DEPENDENT environment |
| pull-to-master | Pulls from the DEPENDENT environment to the MASTER environment |
| create | Creates files to be pushed to Salesforce
|
| config |
|
| query | Runs a SOQL query (requires Python Beatbox) |
| file-push | Pushes a space separated list of files |
| describe-metadata | Describes a specific metatdata field |
| list-metadata | Lists the metadata associated with a type |
| run-tests | Runs a space separated list of classes. If no classes are provided, will run all tests |
| report-diff | Reports the difference between two environments (or the environment and disk) |
| generate-package | Generate a folder based package.xml |
| generate-full-package | Generate a folder based package.xml for all components |
| delta-push | Push only the files that have changed |
| cached-delta-push | Run delta-push without pulling from the MASTER |
| selective-pull | Pull only the requested files |
| selective-pull-to-master | Pull only the requested files to MASTER |