22
33Command-Line tool for interacting with Diffy.
44
5- Great for building integrations for your CI/CD tools. Allows scription taking screenshots, diffs, comparing environments.
5+ Great for building integrations for your CI/CD tools. Allows taking screenshots, diffs, comparing environments.
66
77[ ![ Travis CI] ( https://travis-ci.org/DiffyWebsite/diffy-cli.svg?branch=master )] ( https://travis-ci.org/DiffyWebsite/diffy-cli )
88[ ![ License] ( https://img.shields.io/badge/license-MIT-408677.svg )] ( LICENSE )
@@ -11,14 +11,14 @@ Great for building integrations for your CI/CD tools. Allows scription taking sc
1111
1212### Manual Installation
1313
14- Download latest release from [ https://github.com/DiffyWebsite/diffy-cli/releases ] ( https://github.com/DiffyWebsite/diffy-cli/releases ) page. Download just ` diffy.phar ` file. No need for all the source code. You can copy file to your executables so it is available everywhere.
14+ Download the latest release from [ https://github.com/DiffyWebsite/diffy-cli/releases ] ( https://github.com/DiffyWebsite/diffy-cli/releases ) page. Download just ` diffy.phar ` file. No need for all the source code. You can copy file to your executables so it is available everywhere.
1515
1616``` shell script
1717wget -O /usr/local/bin/diffy https://github.com/diffywebsite/diffy-cli/releases/latest/download/diffy.phar
1818chmod a+x /usr/local/bin/diffy
1919```
2020
21- ### Installion with Composer
21+ ### Installation with Composer
2222
2323``` shell script
2424composer require diffy-website/diffy-cli --with-all-dependencies
@@ -48,7 +48,11 @@ ENVIRONMENT is one of "production", "staging", "development" (short options: "pr
4848
4949You can use ` --wait ` key to wait for the screenshot to be completed.
5050
51- As a result you will get an ID of the screenshot.
51+ As a result, you will get an ID of the screenshot.
52+
53+ #### Compare screenshots (creating diff)
54+
55+ If you know your screenshots IDs the easiest would be:
5256
5357``` shell script
5458diffy diff:create PROJECT_ID SCREENSHOT_ID1 SCREENSHOT_ID2
@@ -59,7 +63,7 @@ Also, you can create diff with custom name:
5963diffy diff:create PROJECT_ID SCREENSHOT_ID1 SCREENSHOT_ID2 --name=" custom"
6064```
6165
62- Compare screenshots with id SCREENSHOT_ID1 and SCREENSHOT_ID2
66+ #### Shortcut to take screenshots and compare them right away
6367
6468``` shell script
6569diffy project:compare PROJECT_ID production staging
@@ -82,12 +86,6 @@ or in case of custom environment with basic auth credentials
8286diffy project:compare PROJECT_ID prod custom --env2Url=" https://custom.example.com" --env2User=" user" --env2Pass=" password"
8387```
8488
85- or with existing screenshots
86-
87- ``` shell script
88- diffy project:compare PROJECT_ID existing existing --screenshot1=100 --screenshot2=101
89- ```
90-
9189Allowed environments are: prod, stage, dev, custom (long options: production, staging, development).
9290
9391#### Update project(s)
@@ -101,14 +99,15 @@ diffy project:update PROJECT_ID ./examples/project-settings.yaml
10199You can download project config file from Project Settings page. See https://docs.diffy.website/features/configure-project-from-yaml-file
102100
103101#### Create project(s)
102+
104103Similar you can create a project by passing the config file.
105104
106105``` shell script
107- diffy project:create ./examples/diffy_create_project.json
106+ diffy project:create ./examples/diffy_create_project.yaml
108107```
109- You can create multiple projects by giving an array of projects.
110108
111109#### Get project information
110+
112111Get the full settings of the project
113112
114113``` shell script
@@ -147,50 +146,6 @@ The only difference you will need to have is to pass commit sha to compare opera
147146diffy project:compare PROJECT_ID prod custom --env2Url=" https://custom.example.com" --commit-sha=" 29b872765b21387b7adfd67fd16b7f11942e1a56"
148147```
149148
150- ### BrowserStack integration
151-
152- If you have Automate Pro plan or higher we can use Screenshot API to generate screenshots and send them to Diffy.
153-
154- For that you need following steps.
155-
156- Save credentials. They can be obtained at [ account setting page] ( https://www.browserstack.com/accounts/settings ) .
157- ``` shell script
158- php diffy browserstack:save-credentials < username> < access_key>
159- ```
160-
161- Get a list of all possible browsers available to choose which ones you would like to use.
162- ``` shell script
163- php diffy browserstack:browsers-list
164- ```
165-
166- Run process of taking screenshots
167- ``` shell script
168- php diffy browserstack:screenshot PROJECT_ID http://url-of-the-site.com safari--6.0--OS__X--Lion,firefox--39.0--Windows--8 --wait=10
169- ```
170-
171- ### LambdaTest integration
172-
173- If you have Live plan or higher we can use Screenshot API to generate screenshots and send them to Diffy.
174-
175- For that you need following steps.
176-
177- First you need to save credentials. They can be obtained at [ account setting page] ( https://accounts.lambdatest.com/detail/profile ) . You need to pass your Username and Access Token.
178- ``` shell script
179- php diffy lambdatest:save-credentials < username> < access_token>
180- ```
181-
182- Get a list of all possible browsers available to choose which ones you would like to use.
183- ``` shell script
184- php diffy lambdatest:browsers-list
185- ```
186-
187- Run process of taking screenshots
188- ``` shell script
189- php diffy lambdatest:screenshot PROJECT_ID http://url-of-the-site.com --wait=10 windows__10--opera--75,windows__10--chrome--90
190- ```
191-
192- Once the job is completed you can see screenshots set appeared in your project.
193-
194149### Examples
195150
196151Take a look at folder with [ Examples] ( https://github.com/DiffyWebsite/diffy-cli/tree/master/examples ) . This is a collection
@@ -270,7 +225,7 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
270225
271226## Authors
272227
273- * ** Yuri Gerasimov ** - created project from template.
228+ * ** Yuri Gerasymov ** - created project from template.
274229
275230See also the list of [ contributors] ( https://github.com/DiffyWebsite/diffy-cli/contributors ) who participated in this project.
276231
0 commit comments