Skip to content

Commit affa9ab

Browse files
committed
Updated README.md
1 parent 0d2c00b commit affa9ab

File tree

1 file changed

+49
-16
lines changed

1 file changed

+49
-16
lines changed

README.md

+49-16
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ php command.php export-import export --format=json --export-path="build/ExportIm
3636
php command.php export-import import --format=json --import-path="build/ExportImport/Import" --import-type=createAndUpdate"
3737
```
3838

39-
## Configuration
39+
## Parameters
4040

4141
### Export Path
4242

4343
Define an export path.
4444

4545
- Attribute: `exportPath`
46-
- CLI attribute: `export-path`
46+
- CLI attribute: `--export-path="PATH"`
4747
- Possible values:
4848
- `any string`
4949
- Default: `build/ExportImport/Export`
@@ -53,53 +53,75 @@ Define an export path.
5353
Define an import path.
5454

5555
- Attribute: `importPath`
56-
- CLI attribute: `import-path`
56+
- CLI attribute: `--import-path="PATH"`
5757
- Possible values:
5858
- `any string`
5959
- Default: `build/ExportImport/Import`
6060

6161
The export / import process can be configured in `custom/Espo/Custom/Resources/metadata/app/exportImport.json` or by cli command.
6262

63+
### Entity Type List
64+
65+
The needed Entity type list can be defined. If empty, then gets all Entity types.
66+
67+
- Attribute: `entityTypeList`
68+
- CLI attribute: `--entity-type-list-list="ENTITY_TYPE1, ENTITY_TYPE2"`
69+
- Possible values:
70+
- `a string`, e.g. `"Account"`
71+
- `a string which is separated by a comma`, e.g. `"Account, Contact"`
72+
- Default: `all available entities`
73+
6374
### Import Type
6475

6576
The type of importing data.
6677

6778
- Attribute: `importType`
68-
- CLI attribute: `import-type`
79+
- CLI attribute: `--import-type="TYPE"`
6980
- Possible values:
7081
- `create`
7182
- `createAndUpdate`
7283
- `update`
7384
- Default: `createAndUpdate`
7485

75-
### User active status
86+
### Pretty Print
87+
88+
Store data in pretty print format.
89+
90+
- Attribute: `prettyPrint`
91+
- CLI attribute: `--pretty-print`
92+
- Possible values:
93+
- `true`
94+
- `false`
95+
- Default: `false`
96+
97+
### User Active Status
7698

7799
Default user status for imported users. This applies to all user except admin user with ID `1`.
78100

79101
- Attribute: `userActive`
80-
- CLI attribute: `user-active`
102+
- CLI attribute: `--user-active`
81103
- Possible values:
82104
- `true`
83105
- `false`
84106
- Default: `false`
85107

86-
### User password
108+
### User Password
87109

88110
User password for imported users.
89111
If empty then generates random values. For resetting the password use `php command.php set-password [username]`.
90112

91113
- Attribute: `userPassword`
92-
- CLI attribute: `user-password`
114+
- CLI attribute: `--user-password`
93115
- Possible values:
94116
- `any string`
95117
- Default: `null`
96118

97-
### Default currency
119+
### Default Currency
98120

99121
The default currency can be defined for every currency field.
100122

101123
- Attribute: `updateCurrency`
102-
- CLI attribute: `update-currency`
124+
- CLI attribute: `--update-currency`
103125
- Possible values:
104126
- `true`
105127
- `false`
@@ -110,7 +132,18 @@ The default currency can be defined for every currency field.
110132
Export / import all customization made for the instance.
111133

112134
- Attribute: `customization`
113-
- CLI attribute: `customization`
135+
- CLI attribute: `--customization`
136+
- Possible values:
137+
- `true`
138+
- `false`
139+
- Default: `false`
140+
141+
### Config
142+
143+
Export / import all customization made for the instance.
144+
145+
- Attribute: `config`
146+
- CLI attribute: `--config`
114147
- Possible values:
115148
- `true`
116149
- `false`
@@ -121,29 +154,29 @@ Export / import all customization made for the instance.
121154
The current time will be defined for the createAt field.
122155

123156
- Attribute: `updateCreatedAt`
124-
- CLI attribute: `update-created-at`
157+
- CLI attribute: `--update-created-at`
125158
- Possible values:
126159
- `true`
127160
- `false`
128161
- Default: `false`
129162

130-
### Hard export entity type list
163+
### Hard Export Entities
131164

132165
This option enables export feature for an entity which is disabled in `exportImportDefs`.
133166

134167
- Attribute: `hardExportList`
135-
- CLI attribute: `hard-export-list`
168+
- CLI attribute: `--hard-export-list="ENTITY_TYPE"`
136169
- Possible values:
137170
- `a string`, e.g. `"Account"`
138171
- `a string which is separated by a comma`, e.g. `"Account, Contact"`
139172
- Default: `null`
140173

141-
### Hard import entity type list
174+
### Hard Import Entities
142175

143176
This option enables import feature for an entity which is disabled in `exportImportDefs`.
144177

145178
- Attribute: `hardImportList`
146-
- CLI attribute: `hard-import-list`
179+
- CLI attribute: `hard-import-list="ENTITY_TYPE"`
147180
- Possible values:
148181
- `a string`, e.g. `"Account"`
149182
- `a string which is separated by a comma`, e.g. `"Account, Contact"`

0 commit comments

Comments
 (0)