UNPKG

22.1 kBJSONView Raw
1{"version":"0.0.1-dev-preview-36","commands":{"login":{"id":"login","description":"sign in to your account","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"sign out of your account","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"share":{"id":"share","description":"create invite link/code for developer preview (allows someone else to create their own account)","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"apps:apply":{"id":"apps:apply","description":"deploy your application to a chosen color","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["dog deploy blue","dog deploy blue --force","dog deploy green --path ./custom/script.js"],"flags":{"force":{"name":"force","type":"boolean","allowNo":false},"path":{"name":"path","type":"option","char":"p"}},"args":[{"name":"color","description":"the backend color to deploy to","required":true,"options":["blue","green"]}]},"apps:build":{"id":"apps:build","description":"build your application from a template script","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog apps:build\n\n# Use a non-default path to your config\ndog apps:build --pathToConfig ./dog-app-config.json\n\n# Or with flag character\ndog apps:build -p ./dog-app-config.json\n"],"flags":{"pathToConfig":{"name":"pathToConfig","type":"option","char":"p","default":"./dog-app-config.json"}},"args":[]},"apps:current":{"id":"apps:current","description":"show currently selected application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"apps:init":{"id":"apps:init","description":"initalize an app in this directory (should be the root of your project)","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"apps:list":{"id":"apps:list","description":"list all apps in your account","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"apps:new":{"id":"apps:new","description":"create a new application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"friendlyName","description":"a friendly display name for your project. the id will be created from this.","required":true}]},"apps:rollback":{"id":"apps:rollback","description":"rollback a color to a prior deployment","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog apps:rollback blue\n\n# Force rollback a backend receiving production traffic\n$ dog apps:rollback blue --force\n"],"flags":{"force":{"name":"force","type":"boolean","allowNo":false}},"args":[{"name":"color","required":true}]},"apps:sharedataset":{"id":"apps:sharedataset","description":"share your BigQuery dataset with an email address associated with a Google Cloud Account","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog apps:sharedataset sarah.smith@example.com\n"],"flags":{},"args":[{"name":"email","required":true}]},"cms:login":{"id":"cms:login","description":"login & open the cms UI","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"cms:preview":{"id":"cms:preview","description":"generate a preview link to a chosen domain","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog cms:preview http://localhost:3000\n\n$ dog cms:preview https://www.example.com\n"],"flags":{},"args":[{"name":"url","description":"must be a fully qualified domain name","required":true,"default":"http://localhost:3000"}]},"domains:add":{"id":"domains:add","description":"attach a CNAME to your application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog domains:add www.example.com\n\n# Validate your domain automatically (default)\n$ dog domains:add www.example.com --validation http\n\n# Validate your domain by placing an extra CNAME with auth code\n$ dog domains:add www.example.com --validation cname\n\n# Validate your domain by receiving an email sent to your WHOIS contacts\n$ dog domains:add www.example.com --validation email\n"],"flags":{"validation":{"name":"validation","type":"option","char":"v","description":"specify the validation method - http happens inline, email will send to the WHOIS contacts, cname will return a record that needs to be placed","options":["http","email","cname"],"default":"http"}},"args":[{"name":"hostname","required":true}]},"domains:list":{"id":"domains:list","description":"list all domains associated with this app","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"domains:status":{"id":"domains:status","description":"check the status of a custom hostname","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog domains:status www.example.com\n"],"flags":{},"args":[{"name":"hostname","required":true}]},"logs:assetLoadTime":{"id":"logs:assetLoadTime","description":"live js & css asset performance","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:assetLoadTime\n{\"asset\":\"https://example.com/build/main.js\",\"color\":\"green\",\"duration\":85,\"protocol\":\"h2\",\"rid\":\"abc-567\",\"vid\":\"abc-123\"}\n\n# Filter by asset\n$ dog logs:assetLoadTime --asset https://example.com/build/main.js\n\n# Pretty print JSON\n$ dog logs:assetLoadTime --prettyjson\n{\n \"asset\": \"https://example.com/build/main.js\",\n \"color\": \"green\",\n \"duration\": 85,\n \"protocol\": \"h2\",\n \"rid\": \"abc-567\",\n \"vid\": \"abc-123\"\n}\n"],"flags":{"asset":{"name":"asset","type":"option","char":"a","description":"filter by fqdn of asset (https://example.com/build/main.js)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:caughtError":{"id":"logs:caughtError","description":"errors your application caught & chose to log","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:caughtError\n\n# Filter by backend color\n$ dog logs:caughtError --color blue\n\n# Pretty print JSON\n$ dog logs:caughtError --prettyjson\n"],"flags":{"color":{"name":"color","type":"option","char":"c","description":"filter by backend color (blue)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:clientPing":{"id":"logs:clientPing","description":"front end application pings","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:clientPing\n\n# Filter by backend color\n$ dog logs:clientPing --color blue\n\n# Pretty print JSON\n$ dog logs:clientPing --prettyjson\n"],"flags":{"color":{"name":"color","type":"option","char":"c","description":"filter by backend color"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:error":{"id":"logs:error","description":"errors caught globally from window.onerror","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:error\n \n# Filter by backend color\n$ dog logs:error --color blue\n \n# Pretty print JSON\n$ dog logs:error --prettyjson\n"],"flags":{"color":{"name":"color","type":"option","char":"c","description":"filter by backend color (blue)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:fps":{"id":"logs:fps","description":"instances of client side frames per second dropping below 50 fps","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:fps\n \n# Filter by backend color\n$ dog logs:fps --color blue\n \n# Pretty print JSON\n$ dog logs:fps --prettyjson\n"],"flags":{"color":{"name":"color","type":"option","char":"c","description":"filter by backend color (blue)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:longTasksTiming":{"id":"logs:longTasksTiming","description":"instances of client side tasks that exceed 50ms using the browsers Long Tasks API","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:longTasksTiming\n \n# Filter by backend color\n$ dog logs:longTasksTiming --color blue\n\n# Pretty print JSON\n$ dog logs:longTasksTiming --prettyjson\n"],"flags":{"color":{"name":"color","type":"option","char":"c","description":"filter by backend color (blue)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:mouseDistance":{"id":"logs:mouseDistance","description":"euclidean mouse distance, over 3 second intervals, from your applications","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:mouseDistance\n \n# Filter by a single request Id\n$ dog logs:mouseDistance --rid abc-123\n \n# Pretty print JSON\n$ dog logs:mouseDistance --prettyjson\n"],"flags":{"rid":{"name":"rid","type":"option","char":"r","description":"filter by a single rid (get it from server or proxy logs)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:orientationChange":{"id":"logs:orientationChange","description":"orientation changes in your application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:orientationChange\n \n# Filter by a single request Id\n$ dog logs:orientationChange --rid abc-123\n \n# Pretty print JSON\n$ dog logs:orientationChange --prettyjson\n"],"flags":{"rid":{"name":"rid","type":"option","char":"r","description":"filter by a single rid (get it from server or proxy logs)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:outcome":{"id":"logs:outcome","description":"custom implemented outcomes from your application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:outcome\n \n# Filter by custom outcome (outcomes defined by user)\n$ dog logs:outcome --outcome cartAddItem\n$ dog logs:outcome --outcome heroImageClick\n$ dog logs:outcome --outcome searchAddFilter\n\n \n# Pretty print JSON\n$ dog logs:outcome --prettyjson\n"],"flags":{"outcome":{"name":"outcome","type":"option","char":"o","description":"filter by outcome (addToCart)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:pageScrolling":{"id":"logs:pageScrolling","description":"scrolling activity from your application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:pageScrolling\n \n# Filter by pathname\n$ dog logs:pageScrolling --pathname /about-us\n \n# Pretty print JSON\n$ dog logs:pageScrolling --prettyjson\n "],"flags":{"pathname":{"name":"pathname","type":"option","char":"n","description":"filter by pathname (/pricing)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:pageView":{"id":"logs:pageView","description":"page views in realtime","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:pageView\n \n# Filter by pathname\n$ dog logs:pageView --pathname /about-us\n \n# Pretty print JSON\n$ dog logs:pageView --prettyjson\n "],"flags":{"pathname":{"name":"pathname","type":"option","char":"n","description":"filter by pathname (/pricing)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:performanceTiming":{"id":"logs:performanceTiming","description":"application performance from the navigation timing api including timeToFirstByte, FCP, & TTI","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:performanceTiming\n \n# Filter by property\n$ dog logs:performanceTiming --property timeToFetchStart\n$ dog logs:performanceTiming --property dnsLookupTime\n$ dog logs:performanceTiming --property timeToFistByte\n$ dog logs:performanceTiming --property timeToHtmlPage\n$ dog logs:performanceTiming --property domInteractive\n$ dog logs:performanceTiming --property pageLoadTime\n$ dog logs:performanceTiming --property firstContentfulPaint\n$ dog logs:performanceTiming --property firstPaint\n$ dog logs:performanceTiming --property firstInputDelay\n$ dog logs:performanceTiming --property tti\n\n\n# Pretty print JSON\n$ dog logs:performanceTiming --prettyjson\n"],"flags":{"property":{"name":"property","type":"option","char":"t","description":"filter by performance timing property"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:proxyLogs":{"id":"logs:proxyLogs","description":"proxy logs","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:proxyLogs\n \n# Filter by country\n$ dog logs:proxyLogs --country US\n \n# Pretty print JSON\n$ dog logs:proxyLogs --prettyjson\n"],"flags":{"country":{"name":"country","type":"option","char":"c","description":"filter proxy logs by a single country code (such as US)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:rapidClicking":{"id":"logs:rapidClicking","description":"incidences of \"rapid/rage clicking\" in your application","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:rapidClicking\n\n# Pretty print JSON\n$ dog logs:rapidClicking --prettyjson\n"],"flags":{"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:serverLogs":{"id":"logs:serverLogs","description":"server logs","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:serverLogs\n \n# Filter by color\n$ dog logs:serverLogs --color green\n \n# Pretty print JSON\n$ dog logs:serverLogs --prettyjson\n"],"flags":{"color":{"name":"color","type":"option","char":"c","description":"filter by backend color (blue)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:timeOnPage":{"id":"logs:timeOnPage","description":"time on page activity events (event values are not cumulative)","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:timeOnPage\n \n# Filter by pathname\n$ dog logs:timeOnPage --pathname /about-us\n \n# Pretty print JSON\n$ dog logs:timeOnPage --prettyjson\n"],"flags":{"pathname":{"name":"pathname","type":"option","char":"n","description":"filter by pathname (/pricing)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:timeOnSite":{"id":"logs:timeOnSite","description":"time on site activity events (event values are not cumulative)","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:timeOnSite\n \n# Filter by visibility\n$ dog logs:timeOnSite --visibility hidden\n \n# Pretty print JSON\n$ dog logs:timeOnSite --prettyjson\n"],"flags":{"visibility":{"name":"visibility","type":"option","char":"v","description":"filter by visibility (hidden)"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:variationInViewport":{"id":"logs:variationInViewport","description":"variations entering the viewport","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:variationInViewport\n \n# Filter by featureId\n$ dog logs:variationInViewport --featureId abc-123\n \n# Pretty print JSON\n$ dog logs:variationInViewport --prettyjson\n"],"flags":{"featureId":{"name":"featureId","type":"option","char":"f","description":"filter by featureId"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"logs:variationMousedown":{"id":"logs:variationMousedown","description":"mousedown events on variations","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog logs:variationMousedown\n \n# Filter by featureId\n$ dog logs:variationMousedown --featureId abc-123\n \n# Pretty print JSON\n$ dog logs:variationMousedown --prettyjson\n"],"flags":{"featureId":{"name":"featureId","type":"option","char":"f","description":"filter by featureId"},"prettyjson":{"name":"prettyjson","type":"boolean","char":"p","description":"print pretty JSON","allowNo":false}},"args":[]},"proxy:abtest":{"id":"proxy:abtest","description":"deploy a/b/n tests across any number of origins","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["# A/B test between your blue and green backends\n$ dog proxy:abtest --origin blue --origin green\n\n# A/B test between your blue backend and example.com\n$ dog proxy:abtest --origin blue --origin https://www.example.com\n\n# A/B test between 3 origins\n$ dog proxy:abtest -o blue -o green -o https://www.example.com\n\n# A/B test between 4 origins\n$ dog proxy:abtest -o blue -o green -o https://www.example.com -o https://www.digitaloptgroup.com\n"],"flags":{"origin":{"name":"origin","type":"option","char":"o","description":"FQDN for an A/B test backend or a valid deployed color","required":true}},"args":[]},"proxy:apply":{"id":"proxy:apply","description":"update your production proxy","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","allowNo":false}},"args":[]},"proxy:canary":{"id":"proxy:canary","description":"run and manage canary releases","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["# Send 20% of your traffic to your green backend as a canary\n$ dog proxy:canary --production blue --canary green --weight 20\n\n# Increase to 50% of your traffic to your green backend\n$ dog proxy:canary -p blue -c green -w 50\n\n# Increase to 75% of your traffic to your green backend\n$ dog proxy:canary -p blue -c green -w 75\n\n# Force reassignment of all visitors on both backends (advanced - not recommended)\n$ dog proxy:canary -p blue -c green -w 50 --reassign\n\n# Decrease traffic allocated to canary backend (advanced - not recommended)\n$ dog proxy:canary -p blue -c green -w 5 --force\n"],"flags":{"production":{"name":"production","type":"option","char":"p","description":"FQDN for production backend or a valid deployed color","required":true},"canary":{"name":"canary","type":"option","char":"c","description":"FQDN for an canary backend or a valid deployed color","required":true},"weight":{"name":"weight","type":"option","char":"w","description":"an integer between 1 and 100 that will equal the percentage of traffic sent to the canary","required":true},"reassign":{"name":"reassign","type":"boolean","description":"forces a new salt to be created and all currently assigned visitors to be reallocated to a random backend - not recommended","allowNo":false},"force":{"name":"force","type":"boolean","description":"force the proxy config to do something that it not recommended","allowNo":false}},"args":[]},"proxy:gatekeep":{"id":"proxy:gatekeep","description":"create a gatekeeping url to any given origin","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog proxy:gatekeep blue\n\n# Gatekeep and open preview mode of the CMS\n$ dog proxy:gatekeep blue --cmsPreview\n\n# Gatekeep to any FQDN on the internet\n$ dog proxy:gatekeep https://www.example.com\n"],"flags":{"cmsPreview":{"name":"cmsPreview","type":"boolean","allowNo":false}},"args":[{"name":"origin","description":"a valid deployed color or a fully qualified domain name","required":true}]},"proxy:localhost":{"id":"proxy:localhost","description":"(experimental) create a gatekeeping url that tunnels to your local development server","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog proxy:localhost\n\n# Tunnel to a custom port (default 3000)\n$ dog proxy:localhost 3001\n\n# Include preview mode of the CMS\n$ dog proxy:localhost 3001 --cmsPreview\n"],"flags":{"cmsPreview":{"name":"cmsPreview","type":"boolean","char":"c","description":"include realtime preview mode in created link","allowNo":false}},"args":[{"name":"port","description":"the port of your local server","default":"3000"}]},"proxy:prod":{"id":"proxy:prod","description":"set your local proxy config to a single production backend","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"examples":["$ dog proxy:prod blue\n\n# Set any FQDN as the production backend\n$ dog proxy:prod https://www.example.com\n"],"flags":{},"args":[{"name":"productionBackend","description":"a valid deployed color or a fully qualified domain name to set as your single production backend","required":true}]},"proxy:refresh":{"id":"proxy:refresh","description":"refresh your local config from production environment","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"proxy:rollback":{"id":"proxy:rollback","description":"rollback proxy to a prior deployment","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"proxy:show":{"id":"proxy:show","description":"show current local & deployed proxy configs","pluginName":"@digitaloptgroup/cli","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
\No newline at end of file