UNPKG

28.7 kBMarkdownView Raw
1# dogcli
2
3Digital Optimization Group Edge Platform CLI - Developer Preview
4
5<!-- toc -->
6* [dogcli](#dogcli)
7* [Usage](#usage)
8* [Commands](#commands)
9<!-- tocstop -->
10
11# Usage
12
13<!-- usage -->
14```sh-session
15$ npm install -g @digitaloptgroup/cli
16$ dog COMMAND
17running command...
18$ dog (-v|--version|version)
19@digitaloptgroup/cli/0.0.1-dev-preview-36 linux-x64 node-v10.14.2
20$ dog --help [COMMAND]
21USAGE
22 $ dog COMMAND
23...
24```
25<!-- usagestop -->
26
27# Commands
28
29<!-- commands -->
30* [`dog apps:apply COLOR`](#dog-appsapply-color)
31* [`dog apps:build`](#dog-appsbuild)
32* [`dog apps:current`](#dog-appscurrent)
33* [`dog apps:init`](#dog-appsinit)
34* [`dog apps:list`](#dog-appslist)
35* [`dog apps:new FRIENDLYNAME`](#dog-appsnew-friendlyname)
36* [`dog apps:rollback COLOR`](#dog-appsrollback-color)
37* [`dog apps:sharedataset EMAIL`](#dog-appssharedataset-email)
38* [`dog autocomplete [SHELL]`](#dog-autocomplete-shell)
39* [`dog cms:login`](#dog-cmslogin)
40* [`dog cms:preview URL`](#dog-cmspreview-url)
41* [`dog domains:add HOSTNAME`](#dog-domainsadd-hostname)
42* [`dog domains:list`](#dog-domainslist)
43* [`dog domains:status HOSTNAME`](#dog-domainsstatus-hostname)
44* [`dog help [COMMAND]`](#dog-help-command)
45* [`dog login`](#dog-login)
46* [`dog logout`](#dog-logout)
47* [`dog logs:assetLoadTime`](#dog-logsassetloadtime)
48* [`dog logs:caughtError`](#dog-logscaughterror)
49* [`dog logs:clientPing`](#dog-logsclientping)
50* [`dog logs:error`](#dog-logserror)
51* [`dog logs:fps`](#dog-logsfps)
52* [`dog logs:longTasksTiming`](#dog-logslongtaskstiming)
53* [`dog logs:mouseDistance`](#dog-logsmousedistance)
54* [`dog logs:orientationChange`](#dog-logsorientationchange)
55* [`dog logs:outcome`](#dog-logsoutcome)
56* [`dog logs:pageScrolling`](#dog-logspagescrolling)
57* [`dog logs:pageView`](#dog-logspageview)
58* [`dog logs:performanceTiming`](#dog-logsperformancetiming)
59* [`dog logs:proxyLogs`](#dog-logsproxylogs)
60* [`dog logs:rapidClicking`](#dog-logsrapidclicking)
61* [`dog logs:serverLogs`](#dog-logsserverlogs)
62* [`dog logs:timeOnPage`](#dog-logstimeonpage)
63* [`dog logs:timeOnSite`](#dog-logstimeonsite)
64* [`dog logs:variationInViewport`](#dog-logsvariationinviewport)
65* [`dog logs:variationMousedown`](#dog-logsvariationmousedown)
66* [`dog plugins`](#dog-plugins)
67* [`dog plugins:install PLUGIN...`](#dog-pluginsinstall-plugin)
68* [`dog plugins:link PLUGIN`](#dog-pluginslink-plugin)
69* [`dog plugins:uninstall PLUGIN...`](#dog-pluginsuninstall-plugin)
70* [`dog plugins:update`](#dog-pluginsupdate)
71* [`dog proxy:abtest`](#dog-proxyabtest)
72* [`dog proxy:apply`](#dog-proxyapply)
73* [`dog proxy:canary`](#dog-proxycanary)
74* [`dog proxy:gatekeep ORIGIN`](#dog-proxygatekeep-origin)
75* [`dog proxy:localhost [PORT]`](#dog-proxylocalhost-port)
76* [`dog proxy:prod PRODUCTIONBACKEND`](#dog-proxyprod-productionbackend)
77* [`dog proxy:refresh`](#dog-proxyrefresh)
78* [`dog proxy:rollback`](#dog-proxyrollback)
79* [`dog proxy:show`](#dog-proxyshow)
80* [`dog share`](#dog-share)
81* [`dog start`](#dog-start)
82
83## `dog apps:apply COLOR`
84
85deploy your application to a chosen color
86
87```
88USAGE
89 $ dog apps:apply COLOR
90
91ARGUMENTS
92 COLOR (blue|green) the backend color to deploy to
93
94OPTIONS
95 -p, --path=path
96 --force
97
98EXAMPLES
99 dog deploy blue
100 dog deploy blue --force
101 dog deploy green --path ./custom/script.js
102```
103
104_See code: [src/commands/apps/apply.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/apply.ts)_
105
106## `dog apps:build`
107
108build your application from a template script
109
110```
111USAGE
112 $ dog apps:build
113
114OPTIONS
115 -p, --pathToConfig=pathToConfig [default: ./dog-app-config.json]
116
117EXAMPLE
118 $ dog apps:build
119
120 # Use a non-default path to your config
121 dog apps:build --pathToConfig ./dog-app-config.json
122
123 # Or with flag character
124 dog apps:build -p ./dog-app-config.json
125```
126
127_See code: [src/commands/apps/build.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/build.ts)_
128
129## `dog apps:current`
130
131show currently selected application
132
133```
134USAGE
135 $ dog apps:current
136```
137
138_See code: [src/commands/apps/current.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/current.ts)_
139
140## `dog apps:init`
141
142initalize an app in this directory (should be the root of your project)
143
144```
145USAGE
146 $ dog apps:init
147```
148
149_See code: [src/commands/apps/init.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/init.ts)_
150
151## `dog apps:list`
152
153list all apps in your account
154
155```
156USAGE
157 $ dog apps:list
158```
159
160_See code: [src/commands/apps/list.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/list.ts)_
161
162## `dog apps:new FRIENDLYNAME`
163
164create a new application
165
166```
167USAGE
168 $ dog apps:new FRIENDLYNAME
169
170ARGUMENTS
171 FRIENDLYNAME a friendly display name for your project. the id will be created from this.
172```
173
174_See code: [src/commands/apps/new.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/new.ts)_
175
176## `dog apps:rollback COLOR`
177
178rollback a color to a prior deployment
179
180```
181USAGE
182 $ dog apps:rollback COLOR
183
184OPTIONS
185 --force
186
187EXAMPLE
188 $ dog apps:rollback blue
189
190 # Force rollback a backend receiving production traffic
191 $ dog apps:rollback blue --force
192```
193
194_See code: [src/commands/apps/rollback.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/rollback.ts)_
195
196## `dog apps:sharedataset EMAIL`
197
198share your BigQuery dataset with an email address associated with a Google Cloud Account
199
200```
201USAGE
202 $ dog apps:sharedataset EMAIL
203
204EXAMPLE
205 $ dog apps:sharedataset sarah.smith@example.com
206```
207
208_See code: [src/commands/apps/sharedataset.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/apps/sharedataset.ts)_
209
210## `dog autocomplete [SHELL]`
211
212display autocomplete installation instructions
213
214```
215USAGE
216 $ dog autocomplete [SHELL]
217
218ARGUMENTS
219 SHELL shell type
220
221OPTIONS
222 -r, --refresh-cache Refresh cache (ignores displaying instructions)
223
224EXAMPLES
225 $ dog autocomplete
226 $ dog autocomplete bash
227 $ dog autocomplete zsh
228 $ dog autocomplete --refresh-cache
229```
230
231_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.1/src/commands/autocomplete/index.ts)_
232
233## `dog cms:login`
234
235login & open the cms UI
236
237```
238USAGE
239 $ dog cms:login
240```
241
242_See code: [src/commands/cms/login.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/cms/login.ts)_
243
244## `dog cms:preview URL`
245
246generate a preview link to a chosen domain
247
248```
249USAGE
250 $ dog cms:preview URL
251
252ARGUMENTS
253 URL [default: http://localhost:3000] must be a fully qualified domain name
254
255EXAMPLE
256 $ dog cms:preview http://localhost:3000
257
258 $ dog cms:preview https://www.example.com
259```
260
261_See code: [src/commands/cms/preview.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/cms/preview.ts)_
262
263## `dog domains:add HOSTNAME`
264
265attach a CNAME to your application
266
267```
268USAGE
269 $ dog domains:add HOSTNAME
270
271OPTIONS
272 -v, --validation=http|email|cname [default: http] specify the validation method - http happens inline, email will
273 send to the WHOIS contacts, cname will return a record that needs to be placed
274
275EXAMPLE
276 $ dog domains:add www.example.com
277
278 # Validate your domain automatically (default)
279 $ dog domains:add www.example.com --validation http
280
281 # Validate your domain by placing an extra CNAME with auth code
282 $ dog domains:add www.example.com --validation cname
283
284 # Validate your domain by receiving an email sent to your WHOIS contacts
285 $ dog domains:add www.example.com --validation email
286```
287
288_See code: [src/commands/domains/add.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/domains/add.ts)_
289
290## `dog domains:list`
291
292list all domains associated with this app
293
294```
295USAGE
296 $ dog domains:list
297```
298
299_See code: [src/commands/domains/list.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/domains/list.ts)_
300
301## `dog domains:status HOSTNAME`
302
303check the status of a custom hostname
304
305```
306USAGE
307 $ dog domains:status HOSTNAME
308
309EXAMPLE
310 $ dog domains:status www.example.com
311```
312
313_See code: [src/commands/domains/status.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/domains/status.ts)_
314
315## `dog help [COMMAND]`
316
317display help for dog
318
319```
320USAGE
321 $ dog help [COMMAND]
322
323ARGUMENTS
324 COMMAND command to show help for
325
326OPTIONS
327 --all see all commands in CLI
328```
329
330_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_
331
332## `dog login`
333
334sign in to your account
335
336```
337USAGE
338 $ dog login
339```
340
341_See code: [src/commands/login.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/login.ts)_
342
343## `dog logout`
344
345sign out of your account
346
347```
348USAGE
349 $ dog logout
350```
351
352_See code: [src/commands/logout.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logout.ts)_
353
354## `dog logs:assetLoadTime`
355
356live js & css asset performance
357
358```
359USAGE
360 $ dog logs:assetLoadTime
361
362OPTIONS
363 -a, --asset=asset filter by fqdn of asset (https://example.com/build/main.js)
364 -p, --prettyjson print pretty JSON
365
366EXAMPLE
367 $ dog logs:assetLoadTime
368 {"asset":"https://example.com/build/main.js","color":"green","duration":85,"protocol":"h2","rid":"abc-567","vid":"abc-
369 123"}
370
371 # Filter by asset
372 $ dog logs:assetLoadTime --asset https://example.com/build/main.js
373
374 # Pretty print JSON
375 $ dog logs:assetLoadTime --prettyjson
376 {
377 "asset": "https://example.com/build/main.js",
378 "color": "green",
379 "duration": 85,
380 "protocol": "h2",
381 "rid": "abc-567",
382 "vid": "abc-123"
383 }
384```
385
386_See code: [src/commands/logs/assetLoadTime.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/assetLoadTime.ts)_
387
388## `dog logs:caughtError`
389
390errors your application caught & chose to log
391
392```
393USAGE
394 $ dog logs:caughtError
395
396OPTIONS
397 -c, --color=color filter by backend color (blue)
398 -p, --prettyjson print pretty JSON
399
400EXAMPLE
401 $ dog logs:caughtError
402
403 # Filter by backend color
404 $ dog logs:caughtError --color blue
405
406 # Pretty print JSON
407 $ dog logs:caughtError --prettyjson
408```
409
410_See code: [src/commands/logs/caughtError.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/caughtError.ts)_
411
412## `dog logs:clientPing`
413
414front end application pings
415
416```
417USAGE
418 $ dog logs:clientPing
419
420OPTIONS
421 -c, --color=color filter by backend color
422 -p, --prettyjson print pretty JSON
423
424EXAMPLE
425 $ dog logs:clientPing
426
427 # Filter by backend color
428 $ dog logs:clientPing --color blue
429
430 # Pretty print JSON
431 $ dog logs:clientPing --prettyjson
432```
433
434_See code: [src/commands/logs/clientPing.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/clientPing.ts)_
435
436## `dog logs:error`
437
438errors caught globally from window.onerror
439
440```
441USAGE
442 $ dog logs:error
443
444OPTIONS
445 -c, --color=color filter by backend color (blue)
446 -p, --prettyjson print pretty JSON
447
448EXAMPLE
449 $ dog logs:error
450
451 # Filter by backend color
452 $ dog logs:error --color blue
453
454 # Pretty print JSON
455 $ dog logs:error --prettyjson
456```
457
458_See code: [src/commands/logs/error.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/error.ts)_
459
460## `dog logs:fps`
461
462instances of client side frames per second dropping below 50 fps
463
464```
465USAGE
466 $ dog logs:fps
467
468OPTIONS
469 -c, --color=color filter by backend color (blue)
470 -p, --prettyjson print pretty JSON
471
472EXAMPLE
473 $ dog logs:fps
474
475 # Filter by backend color
476 $ dog logs:fps --color blue
477
478 # Pretty print JSON
479 $ dog logs:fps --prettyjson
480```
481
482_See code: [src/commands/logs/fps.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/fps.ts)_
483
484## `dog logs:longTasksTiming`
485
486instances of client side tasks that exceed 50ms using the browsers Long Tasks API
487
488```
489USAGE
490 $ dog logs:longTasksTiming
491
492OPTIONS
493 -c, --color=color filter by backend color (blue)
494 -p, --prettyjson print pretty JSON
495
496EXAMPLE
497 $ dog logs:longTasksTiming
498
499 # Filter by backend color
500 $ dog logs:longTasksTiming --color blue
501
502 # Pretty print JSON
503 $ dog logs:longTasksTiming --prettyjson
504```
505
506_See code: [src/commands/logs/longTasksTiming.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/longTasksTiming.ts)_
507
508## `dog logs:mouseDistance`
509
510euclidean mouse distance, over 3 second intervals, from your applications
511
512```
513USAGE
514 $ dog logs:mouseDistance
515
516OPTIONS
517 -p, --prettyjson print pretty JSON
518 -r, --rid=rid filter by a single rid (get it from server or proxy logs)
519
520EXAMPLE
521 $ dog logs:mouseDistance
522
523 # Filter by a single request Id
524 $ dog logs:mouseDistance --rid abc-123
525
526 # Pretty print JSON
527 $ dog logs:mouseDistance --prettyjson
528```
529
530_See code: [src/commands/logs/mouseDistance.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/mouseDistance.ts)_
531
532## `dog logs:orientationChange`
533
534orientation changes in your application
535
536```
537USAGE
538 $ dog logs:orientationChange
539
540OPTIONS
541 -p, --prettyjson print pretty JSON
542 -r, --rid=rid filter by a single rid (get it from server or proxy logs)
543
544EXAMPLE
545 $ dog logs:orientationChange
546
547 # Filter by a single request Id
548 $ dog logs:orientationChange --rid abc-123
549
550 # Pretty print JSON
551 $ dog logs:orientationChange --prettyjson
552```
553
554_See code: [src/commands/logs/orientationChange.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/orientationChange.ts)_
555
556## `dog logs:outcome`
557
558custom implemented outcomes from your application
559
560```
561USAGE
562 $ dog logs:outcome
563
564OPTIONS
565 -o, --outcome=outcome filter by outcome (addToCart)
566 -p, --prettyjson print pretty JSON
567
568EXAMPLE
569 $ dog logs:outcome
570
571 # Filter by custom outcome (outcomes defined by user)
572 $ dog logs:outcome --outcome cartAddItem
573 $ dog logs:outcome --outcome heroImageClick
574 $ dog logs:outcome --outcome searchAddFilter
575
576
577 # Pretty print JSON
578 $ dog logs:outcome --prettyjson
579```
580
581_See code: [src/commands/logs/outcome.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/outcome.ts)_
582
583## `dog logs:pageScrolling`
584
585scrolling activity from your application
586
587```
588USAGE
589 $ dog logs:pageScrolling
590
591OPTIONS
592 -n, --pathname=pathname filter by pathname (/pricing)
593 -p, --prettyjson print pretty JSON
594
595EXAMPLE
596 $ dog logs:pageScrolling
597
598 # Filter by pathname
599 $ dog logs:pageScrolling --pathname /about-us
600
601 # Pretty print JSON
602 $ dog logs:pageScrolling --prettyjson
603```
604
605_See code: [src/commands/logs/pageScrolling.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/pageScrolling.ts)_
606
607## `dog logs:pageView`
608
609page views in realtime
610
611```
612USAGE
613 $ dog logs:pageView
614
615OPTIONS
616 -n, --pathname=pathname filter by pathname (/pricing)
617 -p, --prettyjson print pretty JSON
618
619EXAMPLE
620 $ dog logs:pageView
621
622 # Filter by pathname
623 $ dog logs:pageView --pathname /about-us
624
625 # Pretty print JSON
626 $ dog logs:pageView --prettyjson
627```
628
629_See code: [src/commands/logs/pageView.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/pageView.ts)_
630
631## `dog logs:performanceTiming`
632
633application performance from the navigation timing api including timeToFirstByte, FCP, & TTI
634
635```
636USAGE
637 $ dog logs:performanceTiming
638
639OPTIONS
640 -p, --prettyjson print pretty JSON
641 -t, --property=property filter by performance timing property
642
643EXAMPLE
644 $ dog logs:performanceTiming
645
646 # Filter by property
647 $ dog logs:performanceTiming --property timeToFetchStart
648 $ dog logs:performanceTiming --property dnsLookupTime
649 $ dog logs:performanceTiming --property timeToFistByte
650 $ dog logs:performanceTiming --property timeToHtmlPage
651 $ dog logs:performanceTiming --property domInteractive
652 $ dog logs:performanceTiming --property pageLoadTime
653 $ dog logs:performanceTiming --property firstContentfulPaint
654 $ dog logs:performanceTiming --property firstPaint
655 $ dog logs:performanceTiming --property firstInputDelay
656 $ dog logs:performanceTiming --property tti
657
658
659 # Pretty print JSON
660 $ dog logs:performanceTiming --prettyjson
661```
662
663_See code: [src/commands/logs/performanceTiming.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/performanceTiming.ts)_
664
665## `dog logs:proxyLogs`
666
667proxy logs
668
669```
670USAGE
671 $ dog logs:proxyLogs
672
673OPTIONS
674 -c, --country=country filter proxy logs by a single country code (such as US)
675 -p, --prettyjson print pretty JSON
676
677EXAMPLE
678 $ dog logs:proxyLogs
679
680 # Filter by country
681 $ dog logs:proxyLogs --country US
682
683 # Pretty print JSON
684 $ dog logs:proxyLogs --prettyjson
685```
686
687_See code: [src/commands/logs/proxyLogs.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/proxyLogs.ts)_
688
689## `dog logs:rapidClicking`
690
691incidences of "rapid/rage clicking" in your application
692
693```
694USAGE
695 $ dog logs:rapidClicking
696
697OPTIONS
698 -p, --prettyjson print pretty JSON
699
700EXAMPLE
701 $ dog logs:rapidClicking
702
703 # Pretty print JSON
704 $ dog logs:rapidClicking --prettyjson
705```
706
707_See code: [src/commands/logs/rapidClicking.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/rapidClicking.ts)_
708
709## `dog logs:serverLogs`
710
711server logs
712
713```
714USAGE
715 $ dog logs:serverLogs
716
717OPTIONS
718 -c, --color=color filter by backend color (blue)
719 -p, --prettyjson print pretty JSON
720
721EXAMPLE
722 $ dog logs:serverLogs
723
724 # Filter by color
725 $ dog logs:serverLogs --color green
726
727 # Pretty print JSON
728 $ dog logs:serverLogs --prettyjson
729```
730
731_See code: [src/commands/logs/serverLogs.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/serverLogs.ts)_
732
733## `dog logs:timeOnPage`
734
735time on page activity events (event values are not cumulative)
736
737```
738USAGE
739 $ dog logs:timeOnPage
740
741OPTIONS
742 -n, --pathname=pathname filter by pathname (/pricing)
743 -p, --prettyjson print pretty JSON
744
745EXAMPLE
746 $ dog logs:timeOnPage
747
748 # Filter by pathname
749 $ dog logs:timeOnPage --pathname /about-us
750
751 # Pretty print JSON
752 $ dog logs:timeOnPage --prettyjson
753```
754
755_See code: [src/commands/logs/timeOnPage.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/timeOnPage.ts)_
756
757## `dog logs:timeOnSite`
758
759time on site activity events (event values are not cumulative)
760
761```
762USAGE
763 $ dog logs:timeOnSite
764
765OPTIONS
766 -p, --prettyjson print pretty JSON
767 -v, --visibility=visibility filter by visibility (hidden)
768
769EXAMPLE
770 $ dog logs:timeOnSite
771
772 # Filter by visibility
773 $ dog logs:timeOnSite --visibility hidden
774
775 # Pretty print JSON
776 $ dog logs:timeOnSite --prettyjson
777```
778
779_See code: [src/commands/logs/timeOnSite.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/timeOnSite.ts)_
780
781## `dog logs:variationInViewport`
782
783variations entering the viewport
784
785```
786USAGE
787 $ dog logs:variationInViewport
788
789OPTIONS
790 -f, --featureId=featureId filter by featureId
791 -p, --prettyjson print pretty JSON
792
793EXAMPLE
794 $ dog logs:variationInViewport
795
796 # Filter by featureId
797 $ dog logs:variationInViewport --featureId abc-123
798
799 # Pretty print JSON
800 $ dog logs:variationInViewport --prettyjson
801```
802
803_See code: [src/commands/logs/variationInViewport.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/variationInViewport.ts)_
804
805## `dog logs:variationMousedown`
806
807mousedown events on variations
808
809```
810USAGE
811 $ dog logs:variationMousedown
812
813OPTIONS
814 -f, --featureId=featureId filter by featureId
815 -p, --prettyjson print pretty JSON
816
817EXAMPLE
818 $ dog logs:variationMousedown
819
820 # Filter by featureId
821 $ dog logs:variationMousedown --featureId abc-123
822
823 # Pretty print JSON
824 $ dog logs:variationMousedown --prettyjson
825```
826
827_See code: [src/commands/logs/variationMousedown.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/logs/variationMousedown.ts)_
828
829## `dog plugins`
830
831list installed plugins
832
833```
834USAGE
835 $ dog plugins
836
837OPTIONS
838 --core show core plugins
839
840EXAMPLE
841 $ dog plugins
842```
843
844_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/index.ts)_
845
846## `dog plugins:install PLUGIN...`
847
848installs a plugin into the CLI
849
850```
851USAGE
852 $ dog plugins:install PLUGIN...
853
854ARGUMENTS
855 PLUGIN plugin to install
856
857OPTIONS
858 -f, --force yarn install with force flag
859 -h, --help show CLI help
860 -v, --verbose
861
862DESCRIPTION
863 Can be installed from npm or a git url.
864
865 Installation of a user-installed plugin will override a core plugin.
866
867 e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
868 will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
869 the CLI without the need to patch and update the whole CLI.
870
871ALIASES
872 $ dog plugins:add
873
874EXAMPLES
875 $ dog plugins:install myplugin
876 $ dog plugins:install https://github.com/someuser/someplugin
877 $ dog plugins:install someuser/someplugin
878```
879
880_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/install.ts)_
881
882## `dog plugins:link PLUGIN`
883
884links a plugin into the CLI for development
885
886```
887USAGE
888 $ dog plugins:link PLUGIN
889
890ARGUMENTS
891 PATH [default: .] path to plugin
892
893OPTIONS
894 -h, --help show CLI help
895 -v, --verbose
896
897DESCRIPTION
898 Installation of a linked plugin will override a user-installed or core plugin.
899
900 e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
901 command will override the user-installed or core plugin implementation. This is useful for development work.
902
903EXAMPLE
904 $ dog plugins:link myplugin
905```
906
907_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/link.ts)_
908
909## `dog plugins:uninstall PLUGIN...`
910
911removes a plugin from the CLI
912
913```
914USAGE
915 $ dog plugins:uninstall PLUGIN...
916
917ARGUMENTS
918 PLUGIN plugin to uninstall
919
920OPTIONS
921 -h, --help show CLI help
922 -v, --verbose
923
924ALIASES
925 $ dog plugins:unlink
926 $ dog plugins:remove
927```
928
929_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/uninstall.ts)_
930
931## `dog plugins:update`
932
933update installed plugins
934
935```
936USAGE
937 $ dog plugins:update
938
939OPTIONS
940 -h, --help show CLI help
941 -v, --verbose
942```
943
944_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.7.8/src/commands/plugins/update.ts)_
945
946## `dog proxy:abtest`
947
948deploy a/b/n tests across any number of origins
949
950```
951USAGE
952 $ dog proxy:abtest
953
954OPTIONS
955 -o, --origin=origin (required) FQDN for an A/B test backend or a valid deployed color
956
957EXAMPLE
958 # A/B test between your blue and green backends
959 $ dog proxy:abtest --origin blue --origin green
960
961 # A/B test between your blue backend and example.com
962 $ dog proxy:abtest --origin blue --origin https://www.example.com
963
964 # A/B test between 3 origins
965 $ dog proxy:abtest -o blue -o green -o https://www.example.com
966
967 # A/B test between 4 origins
968 $ dog proxy:abtest -o blue -o green -o https://www.example.com -o https://www.digitaloptgroup.com
969```
970
971_See code: [src/commands/proxy/abtest.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/abtest.ts)_
972
973## `dog proxy:apply`
974
975update your production proxy
976
977```
978USAGE
979 $ dog proxy:apply
980
981OPTIONS
982 -f, --force
983```
984
985_See code: [src/commands/proxy/apply.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/apply.ts)_
986
987## `dog proxy:canary`
988
989run and manage canary releases
990
991```
992USAGE
993 $ dog proxy:canary
994
995OPTIONS
996 -c, --canary=canary (required) FQDN for an canary backend or a valid deployed color
997 -p, --production=production (required) FQDN for production backend or a valid deployed color
998
999 -w, --weight=weight (required) an integer between 1 and 100 that will equal the percentage of traffic sent to
1000 the canary
1001
1002 --force force the proxy config to do something that it not recommended
1003
1004 --reassign forces a new salt to be created and all currently assigned visitors to be reallocated to
1005 a random backend - not recommended
1006
1007EXAMPLE
1008 # Send 20% of your traffic to your green backend as a canary
1009 $ dog proxy:canary --production blue --canary green --weight 20
1010
1011 # Increase to 50% of your traffic to your green backend
1012 $ dog proxy:canary -p blue -c green -w 50
1013
1014 # Increase to 75% of your traffic to your green backend
1015 $ dog proxy:canary -p blue -c green -w 75
1016
1017 # Force reassignment of all visitors on both backends (advanced - not recommended)
1018 $ dog proxy:canary -p blue -c green -w 50 --reassign
1019
1020 # Decrease traffic allocated to canary backend (advanced - not recommended)
1021 $ dog proxy:canary -p blue -c green -w 5 --force
1022```
1023
1024_See code: [src/commands/proxy/canary.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/canary.ts)_
1025
1026## `dog proxy:gatekeep ORIGIN`
1027
1028create a gatekeeping url to any given origin
1029
1030```
1031USAGE
1032 $ dog proxy:gatekeep ORIGIN
1033
1034ARGUMENTS
1035 ORIGIN a valid deployed color or a fully qualified domain name
1036
1037OPTIONS
1038 --cmsPreview
1039
1040EXAMPLE
1041 $ dog proxy:gatekeep blue
1042
1043 # Gatekeep and open preview mode of the CMS
1044 $ dog proxy:gatekeep blue --cmsPreview
1045
1046 # Gatekeep to any FQDN on the internet
1047 $ dog proxy:gatekeep https://www.example.com
1048```
1049
1050_See code: [src/commands/proxy/gatekeep.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/gatekeep.ts)_
1051
1052## `dog proxy:localhost [PORT]`
1053
1054(experimental) create a gatekeeping url that tunnels to your local development server
1055
1056```
1057USAGE
1058 $ dog proxy:localhost [PORT]
1059
1060ARGUMENTS
1061 PORT [default: 3000] the port of your local server
1062
1063OPTIONS
1064 -c, --cmsPreview include realtime preview mode in created link
1065
1066EXAMPLE
1067 $ dog proxy:localhost
1068
1069 # Tunnel to a custom port (default 3000)
1070 $ dog proxy:localhost 3001
1071
1072 # Include preview mode of the CMS
1073 $ dog proxy:localhost 3001 --cmsPreview
1074```
1075
1076_See code: [src/commands/proxy/localhost.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/localhost.ts)_
1077
1078## `dog proxy:prod PRODUCTIONBACKEND`
1079
1080set your local proxy config to a single production backend
1081
1082```
1083USAGE
1084 $ dog proxy:prod PRODUCTIONBACKEND
1085
1086ARGUMENTS
1087 PRODUCTIONBACKEND a valid deployed color or a fully qualified domain name to set as your single production backend
1088
1089EXAMPLE
1090 $ dog proxy:prod blue
1091
1092 # Set any FQDN as the production backend
1093 $ dog proxy:prod https://www.example.com
1094```
1095
1096_See code: [src/commands/proxy/prod.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/prod.ts)_
1097
1098## `dog proxy:refresh`
1099
1100refresh your local config from production environment
1101
1102```
1103USAGE
1104 $ dog proxy:refresh
1105```
1106
1107_See code: [src/commands/proxy/refresh.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/refresh.ts)_
1108
1109## `dog proxy:rollback`
1110
1111rollback proxy to a prior deployment
1112
1113```
1114USAGE
1115 $ dog proxy:rollback
1116```
1117
1118_See code: [src/commands/proxy/rollback.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/rollback.ts)_
1119
1120## `dog proxy:show`
1121
1122show current local & deployed proxy configs
1123
1124```
1125USAGE
1126 $ dog proxy:show
1127```
1128
1129_See code: [src/commands/proxy/show.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/proxy/show.ts)_
1130
1131## `dog share`
1132
1133create invite link/code for developer preview (allows someone else to create their own account)
1134
1135```
1136USAGE
1137 $ dog share
1138```
1139
1140_See code: [src/commands/share.ts](https://github.com/DigitalOptGroup/dogcli/blob/v0.0.1-dev-preview-36/src/commands/share.ts)_
1141
1142## `dog start`
1143
1144run a local server for development
1145
1146```
1147USAGE
1148 $ dog start
1149
1150OPTIONS
1151 -p, --port=port
1152 -s, --script=script
1153```
1154
1155_See code: [@digitaloptgroup/plugin-install-start](https://github.com/DigitalOptGroup/plugin-install-start/blob/v0.0.1-devpreview-02/src/commands/start.ts)_
1156<!-- commandsstop -->