diff --git a/404.html b/404.html index 9630e31..3c13e71 100644 --- a/404.html +++ b/404.html @@ -4,14 +4,14 @@ Page Not Found | DotSlash - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/_src/flags.md b/_src/flags.md index 1dcd27d..e02af2b 100644 --- a/_src/flags.md +++ b/_src/flags.md @@ -39,13 +39,14 @@ $ dotslash -- cache-dir /Users/mbolin/Library/Caches/dotslash ``` -| command | description | -| ---------------------- | ----------------------------------------------------------------- | -| `b3sum FILE` | prints the BLAKE3 hash of `FILE` | -| `cache-dir` | prints the absolute path to the user's DotSlash cache and exits | -| `create-url-entry URL` | generates the DotSlash JSON snippet for the artifact at the URL | -| `parse DOTSLASH_FILE` | parses `DOTSLASH_FILE` and prints the data as pure JSON to stdout | -| `sha256 FILE` | prints the SHA-256 hash of `FILE` | +| command | description | +| ---------------------- | ------------------------------------------------------------------------------------ | +| `b3sum FILE` | prints the BLAKE3 hash of `FILE` | +| `cache-dir` | prints the absolute path to the user's DotSlash cache and exits | +| `create-url-entry URL` | generates the DotSlash JSON snippet for the artifact at the URL | +| `fetch DOTSLASH_FILE` | fetches the artifact identified by `DOTSLASH_FILE` if it is not already in the cache | +| `parse DOTSLASH_FILE` | parses `DOTSLASH_FILE` and prints the data as pure JSON to stdout | +| `sha256 FILE` | prints the SHA-256 hash of `FILE` | ## Environment Variables diff --git a/assets/js/a6098f0f.536e2248.js b/assets/js/a6098f0f.88076c1e.js similarity index 65% rename from assets/js/a6098f0f.536e2248.js rename to assets/js/a6098f0f.88076c1e.js index 9b80465..f90639e 100644 --- a/assets/js/a6098f0f.536e2248.js +++ b/assets/js/a6098f0f.88076c1e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdotslash_website=self.webpackChunkdotslash_website||[]).push([[383],{3905:(e,t,a)=>{a.r(t),a.d(t,{MDXContext:()=>m,MDXProvider:()=>u,mdx:()=>f,useMDXComponents:()=>p,withMDXComponents:()=>s});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(){return l=Object.assign||function(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var m=n.createContext({}),s=function(e){return function(t){var a=p(t.components);return n.createElement(e,l({},t,{components:a}))}},p=function(e){var t=n.useContext(m),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},u=function(e){var t=p(e.components);return n.createElement(m.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},x=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),s=p(a),u=r,c=s["".concat(d,".").concat(u)]||s[u]||h[u]||l;return a?n.createElement(c,i(i({ref:t},m),{},{components:a})):n.createElement(c,i({ref:t},m))}));function f(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,d=new Array(l);d[0]=x;var i={};for(var o in t)hasOwnProperty.call(t,o)&&(i[o]=t[o]);i.originalType=e,i[c]="string"==typeof e?e:r,d[1]=i;for(var m=2;m{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>m});var n=a(87462),r=(a(67294),a(3905));const l={sidebar_position:14},d="Command Line Flags",i={unversionedId:"flags",id:"flags",title:"Command Line Flags",description:"Because the usage of DotSlash is:",source:"@site/docs/flags.md",sourceDirName:".",slug:"/flags",permalink:"/docs/flags",draft:!1,editUrl:"https://github.com/facebook/dotslash/tree/main/website/docs/flags.md",tags:[],version:"current",sidebarPosition:14,frontMatter:{sidebar_position:14},sidebar:"tutorialSidebar",previous:{title:"DotSlash File Schema",permalink:"/docs/dotslash-file"},next:{title:"Generating DotSlash files Using GitHub Actions",permalink:"/docs/github"}},o={},m=[{value:"Supported Flags",id:"supported-flags",level:2},{value:"Experimental Commands",id:"experimental-commands",level:2},{value:"Environment Variables",id:"environment-variables",level:2}],s={toc:m},p="wrapper";function u(e){let{components:t,...a}=e;return(0,r.mdx)(p,(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)("h1",{id:"command-line-flags"},"Command Line Flags"),(0,r.mdx)("p",null,"Because the usage of DotSlash is:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-shell"},"dotslash DOTSLASH_FILE [OPTIONS]\n")),(0,r.mdx)("p",null,"where ",(0,r.mdx)("inlineCode",{parentName:"p"},"[OPTIONS]")," is forwarded to the executable represented by ",(0,r.mdx)("inlineCode",{parentName:"p"},"DOTSLASH_FILE"),",\nDotSlash's own command line flags must be able to be disambiguated from\n",(0,r.mdx)("inlineCode",{parentName:"p"},"DOTSLASH_FILE"),". In practice, that means any flag recognized by DotSlash is an\nunsupported DotSlash file name. For this reason, the set of supported flags is\nfairly limited."),(0,r.mdx)("h2",{id:"supported-flags"},"Supported Flags"),(0,r.mdx)("table",null,(0,r.mdx)("thead",{parentName:"table"},(0,r.mdx)("tr",{parentName:"thead"},(0,r.mdx)("th",{parentName:"tr",align:null},"flag"),(0,r.mdx)("th",{parentName:"tr",align:null},"description"))),(0,r.mdx)("tbody",{parentName:"table"},(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"--help")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints basic usage info, as well as the ",(0,r.mdx)("em",{parentName:"td"},"platform")," it was compiled for (which is the entry it will use from the ",(0,r.mdx)("inlineCode",{parentName:"td"},'"platforms"')," map in a DotSlash file)")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("nobr",null,(0,r.mdx)("inlineCode",{parentName:"td"},"--version"))),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the DotSlash version number and exits")))),(0,r.mdx)("h2",{id:"experimental-commands"},"Experimental Commands"),(0,r.mdx)("p",null,'Experimental commands are special flags that we are not committed to supporting,\nand whose output format should be considered unstable. These commands are\n"hidden" behind ',(0,r.mdx)("inlineCode",{parentName:"p"},"--")," (using ",(0,r.mdx)("inlineCode",{parentName:"p"},"--")," as the first argument to ",(0,r.mdx)("inlineCode",{parentName:"p"},"dotslash")," tells it to\nuse a special argument parser) and are used like so:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-shell"},"$ dotslash -- cache-dir\n/Users/mbolin/Library/Caches/dotslash\n")),(0,r.mdx)("table",null,(0,r.mdx)("thead",{parentName:"table"},(0,r.mdx)("tr",{parentName:"thead"},(0,r.mdx)("th",{parentName:"tr",align:null},"command"),(0,r.mdx)("th",{parentName:"tr",align:null},"description"))),(0,r.mdx)("tbody",{parentName:"table"},(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"b3sum FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the BLAKE3 hash of ",(0,r.mdx)("inlineCode",{parentName:"td"},"FILE"))),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"cache-dir")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the absolute path to the user's DotSlash cache and exits")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"create-url-entry URL")),(0,r.mdx)("td",{parentName:"tr",align:null},"generates the DotSlash JSON snippet for the artifact at the URL")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"parse DOTSLASH_FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"parses ",(0,r.mdx)("inlineCode",{parentName:"td"},"DOTSLASH_FILE")," and prints the data as pure JSON to stdout")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"sha256 FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the SHA-256 hash of ",(0,r.mdx)("inlineCode",{parentName:"td"},"FILE"))))),(0,r.mdx)("h2",{id:"environment-variables"},"Environment Variables"),(0,r.mdx)("p",null,"The ",(0,r.mdx)("inlineCode",{parentName:"p"},"DOTSLASH_CACHE")," environment variable can be used to override the default\nlocation of the DotSlash cache. By default, the DotSlash cache resides at:"),(0,r.mdx)("table",null,(0,r.mdx)("thead",{parentName:"table"},(0,r.mdx)("tr",{parentName:"thead"},(0,r.mdx)("th",{parentName:"tr",align:null},"platform"),(0,r.mdx)("th",{parentName:"tr",align:null},"path"))),(0,r.mdx)("tbody",{parentName:"table"},(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},"Linux"),(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"$XDG_CACHE_HOME/dotslash")," or `$HOME/.cache/dotslash")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},"macOS"),(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"$HOME/Library/Caches/dotslash"))),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},"Windows"),(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"{FOLDERID_LocalAppData}/dotslash"))))),(0,r.mdx)("p",null,"DotSlash relies on\n",(0,r.mdx)("a",{parentName:"p",href:"https://docs.rs/dirs/5.0.1/dirs/fn.cache_dir.html"},(0,r.mdx)("inlineCode",{parentName:"a"},"dirs::cache_dir()"))," to use\nthe appropriate default directory on each platform."))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdotslash_website=self.webpackChunkdotslash_website||[]).push([[383],{3905:(e,t,a)=>{a.r(t),a.d(t,{MDXContext:()=>o,MDXProvider:()=>u,mdx:()=>f,useMDXComponents:()=>p,withMDXComponents:()=>s});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(){return l=Object.assign||function(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){return function(t){var a=p(t.components);return n.createElement(e,l({},t,{components:a}))}},p=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},u=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},x=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,o=m(e,["components","mdxType","originalType","parentName"]),s=p(a),u=r,c=s["".concat(d,".").concat(u)]||s[u]||h[u]||l;return a?n.createElement(c,i(i({ref:t},o),{},{components:a})):n.createElement(c,i({ref:t},o))}));function f(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,d=new Array(l);d[0]=x;var i={};for(var m in t)hasOwnProperty.call(t,m)&&(i[m]=t[m]);i.originalType=e,i[c]="string"==typeof e?e:r,d[1]=i;for(var o=2;o{a.r(t),a.d(t,{assets:()=>m,contentTitle:()=>d,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var n=a(87462),r=(a(67294),a(3905));const l={sidebar_position:14},d="Command Line Flags",i={unversionedId:"flags",id:"flags",title:"Command Line Flags",description:"Because the usage of DotSlash is:",source:"@site/docs/flags.md",sourceDirName:".",slug:"/flags",permalink:"/docs/flags",draft:!1,editUrl:"https://github.com/facebook/dotslash/tree/main/website/docs/flags.md",tags:[],version:"current",sidebarPosition:14,frontMatter:{sidebar_position:14},sidebar:"tutorialSidebar",previous:{title:"DotSlash File Schema",permalink:"/docs/dotslash-file"},next:{title:"Generating DotSlash files Using GitHub Actions",permalink:"/docs/github"}},m={},o=[{value:"Supported Flags",id:"supported-flags",level:2},{value:"Experimental Commands",id:"experimental-commands",level:2},{value:"Environment Variables",id:"environment-variables",level:2}],s={toc:o},p="wrapper";function u(e){let{components:t,...a}=e;return(0,r.mdx)(p,(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)("h1",{id:"command-line-flags"},"Command Line Flags"),(0,r.mdx)("p",null,"Because the usage of DotSlash is:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-shell"},"dotslash DOTSLASH_FILE [OPTIONS]\n")),(0,r.mdx)("p",null,"where ",(0,r.mdx)("inlineCode",{parentName:"p"},"[OPTIONS]")," is forwarded to the executable represented by ",(0,r.mdx)("inlineCode",{parentName:"p"},"DOTSLASH_FILE"),",\nDotSlash's own command line flags must be able to be disambiguated from\n",(0,r.mdx)("inlineCode",{parentName:"p"},"DOTSLASH_FILE"),". In practice, that means any flag recognized by DotSlash is an\nunsupported DotSlash file name. For this reason, the set of supported flags is\nfairly limited."),(0,r.mdx)("h2",{id:"supported-flags"},"Supported Flags"),(0,r.mdx)("table",null,(0,r.mdx)("thead",{parentName:"table"},(0,r.mdx)("tr",{parentName:"thead"},(0,r.mdx)("th",{parentName:"tr",align:null},"flag"),(0,r.mdx)("th",{parentName:"tr",align:null},"description"))),(0,r.mdx)("tbody",{parentName:"table"},(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"--help")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints basic usage info, as well as the ",(0,r.mdx)("em",{parentName:"td"},"platform")," it was compiled for (which is the entry it will use from the ",(0,r.mdx)("inlineCode",{parentName:"td"},'"platforms"')," map in a DotSlash file)")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("nobr",null,(0,r.mdx)("inlineCode",{parentName:"td"},"--version"))),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the DotSlash version number and exits")))),(0,r.mdx)("h2",{id:"experimental-commands"},"Experimental Commands"),(0,r.mdx)("p",null,'Experimental commands are special flags that we are not committed to supporting,\nand whose output format should be considered unstable. These commands are\n"hidden" behind ',(0,r.mdx)("inlineCode",{parentName:"p"},"--")," (using ",(0,r.mdx)("inlineCode",{parentName:"p"},"--")," as the first argument to ",(0,r.mdx)("inlineCode",{parentName:"p"},"dotslash")," tells it to\nuse a special argument parser) and are used like so:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-shell"},"$ dotslash -- cache-dir\n/Users/mbolin/Library/Caches/dotslash\n")),(0,r.mdx)("table",null,(0,r.mdx)("thead",{parentName:"table"},(0,r.mdx)("tr",{parentName:"thead"},(0,r.mdx)("th",{parentName:"tr",align:null},"command"),(0,r.mdx)("th",{parentName:"tr",align:null},"description"))),(0,r.mdx)("tbody",{parentName:"table"},(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"b3sum FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the BLAKE3 hash of ",(0,r.mdx)("inlineCode",{parentName:"td"},"FILE"))),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"cache-dir")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the absolute path to the user's DotSlash cache and exits")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"create-url-entry URL")),(0,r.mdx)("td",{parentName:"tr",align:null},"generates the DotSlash JSON snippet for the artifact at the URL")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"fetch DOTSLASH_FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"fetches the artifact identified by ",(0,r.mdx)("inlineCode",{parentName:"td"},"DOTSLASH_FILE")," if it is not already in the cache")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"parse DOTSLASH_FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"parses ",(0,r.mdx)("inlineCode",{parentName:"td"},"DOTSLASH_FILE")," and prints the data as pure JSON to stdout")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"sha256 FILE")),(0,r.mdx)("td",{parentName:"tr",align:null},"prints the SHA-256 hash of ",(0,r.mdx)("inlineCode",{parentName:"td"},"FILE"))))),(0,r.mdx)("h2",{id:"environment-variables"},"Environment Variables"),(0,r.mdx)("p",null,"The ",(0,r.mdx)("inlineCode",{parentName:"p"},"DOTSLASH_CACHE")," environment variable can be used to override the default\nlocation of the DotSlash cache. By default, the DotSlash cache resides at:"),(0,r.mdx)("table",null,(0,r.mdx)("thead",{parentName:"table"},(0,r.mdx)("tr",{parentName:"thead"},(0,r.mdx)("th",{parentName:"tr",align:null},"platform"),(0,r.mdx)("th",{parentName:"tr",align:null},"path"))),(0,r.mdx)("tbody",{parentName:"table"},(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},"Linux"),(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"$XDG_CACHE_HOME/dotslash")," or `$HOME/.cache/dotslash")),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},"macOS"),(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"$HOME/Library/Caches/dotslash"))),(0,r.mdx)("tr",{parentName:"tbody"},(0,r.mdx)("td",{parentName:"tr",align:null},"Windows"),(0,r.mdx)("td",{parentName:"tr",align:null},(0,r.mdx)("inlineCode",{parentName:"td"},"{FOLDERID_LocalAppData}/dotslash"))))),(0,r.mdx)("p",null,"DotSlash relies on\n",(0,r.mdx)("a",{parentName:"p",href:"https://docs.rs/dirs/5.0.1/dirs/fn.cache_dir.html"},(0,r.mdx)("inlineCode",{parentName:"a"},"dirs::cache_dir()"))," to use\nthe appropriate default directory on each platform."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.884ce981.js b/assets/js/runtime~main.884ce981.js deleted file mode 100644 index 63dd8ad..0000000 --- a/assets/js/runtime~main.884ce981.js +++ /dev/null @@ -1 +0,0 @@ -(()=>{"use strict";var e,t,r,a,o,n={},d={};function f(e){var t=d[e];if(void 0!==t)return t.exports;var r=d[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,f),r.loaded=!0,r.exports}f.m=n,f.c=d,e=[],f.O=(t,r,a,o)=>{if(!r){var n=1/0;for(l=0;l=o)&&Object.keys(f.O).every((e=>f.O[e](r[i])))?r.splice(i--,1):(d=!1,o0&&e[l-1][2]>o;l--)e[l]=e[l-1];e[l]=[r,a,o]},f.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return f.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,f.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);f.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var d=2&a&&e;"object"==typeof d&&!~t.indexOf(d);d=r(d))Object.getOwnPropertyNames(d).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,f.d(o,n),o},f.d=(e,t)=>{for(var r in t)f.o(t,r)&&!f.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},f.f={},f.e=e=>Promise.all(Object.keys(f.f).reduce(((t,r)=>(f.f[r](e,t),t)),[])),f.u=e=>"assets/js/"+({53:"935f2afb",85:"1f391b9e",87:"1476a8a4",195:"c4f5d8e4",217:"3b8c55ea",243:"e88f4f61",275:"d1ed757f",297:"786913ef",383:"a6098f0f",414:"393be207",507:"3fd9d943",514:"1be78505",559:"109f1412",795:"aa6bd851",893:"921e9125",918:"17896441",971:"c377a04b"}[e]||e)+"."+{53:"fb1a424a",85:"70a41495",87:"e3ac053c",195:"cb10fb5b",217:"d8b21bb7",243:"0670373f",275:"e8f9cca4",297:"675b1b86",383:"536e2248",414:"51a57482",507:"9029c128",514:"35bb2b49",559:"09e7353f",698:"f9a5fd17",795:"adfa91ce",893:"e2186825",918:"56b066cd",971:"bff86f80",972:"4d45e529"}[e]+".js",f.miniCssF=e=>{},f.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),f.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="dotslash-website:",f.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var d,i;if(void 0!==r)for(var c=document.getElementsByTagName("script"),l=0;l{d.onerror=d.onload=null,clearTimeout(b);var o=a[e];if(delete a[e],d.parentNode&&d.parentNode.removeChild(d),o&&o.forEach((e=>e(r))),t)return t(r)},b=setTimeout(u.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=u.bind(null,d.onerror),d.onload=u.bind(null,d.onload),i&&document.head.appendChild(d)}},f.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),f.p="/",f.gca=function(e){return e={17896441:"918","935f2afb":"53","1f391b9e":"85","1476a8a4":"87",c4f5d8e4:"195","3b8c55ea":"217",e88f4f61:"243",d1ed757f:"275","786913ef":"297",a6098f0f:"383","393be207":"414","3fd9d943":"507","1be78505":"514","109f1412":"559",aa6bd851:"795","921e9125":"893",c377a04b:"971"}[e]||e,f.p+f.u(e)},(()=>{var e={303:0,532:0};f.f.j=(t,r)=>{var a=f.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var n=f.p+f.u(t),d=new Error;f.l(n,(r=>{if(f.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;d.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",d.name="ChunkLoadError",d.type=o,d.request=n,a[1](d)}}),"chunk-"+t,t)}},f.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],d=r[1],i=r[2],c=0;if(n.some((t=>0!==e[t]))){for(a in d)f.o(d,a)&&(f.m[a]=d[a]);if(i)var l=i(f)}for(t&&t(r);c{"use strict";var e,t,r,a,o,n={},f={};function d(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=n,d.c=f,e=[],d.O=(t,r,a,o)=>{if(!r){var n=1/0;for(l=0;l=o)&&Object.keys(d.O).every((e=>d.O[e](r[i])))?r.splice(i--,1):(f=!1,o0&&e[l-1][2]>o;l--)e[l]=e[l-1];e[l]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&a&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,d.d(o,n),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",85:"1f391b9e",87:"1476a8a4",195:"c4f5d8e4",217:"3b8c55ea",243:"e88f4f61",275:"d1ed757f",297:"786913ef",383:"a6098f0f",414:"393be207",507:"3fd9d943",514:"1be78505",559:"109f1412",795:"aa6bd851",893:"921e9125",918:"17896441",971:"c377a04b"}[e]||e)+"."+{53:"fb1a424a",85:"70a41495",87:"e3ac053c",195:"cb10fb5b",217:"d8b21bb7",243:"0670373f",275:"e8f9cca4",297:"675b1b86",383:"88076c1e",414:"51a57482",507:"9029c128",514:"35bb2b49",559:"09e7353f",698:"f9a5fd17",795:"adfa91ce",893:"e2186825",918:"56b066cd",971:"bff86f80",972:"4d45e529"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="dotslash-website:",d.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,i;if(void 0!==r)for(var c=document.getElementsByTagName("script"),l=0;l{f.onerror=f.onload=null,clearTimeout(b);var o=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),o&&o.forEach((e=>e(r))),t)return t(r)},b=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),i&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),d.p="/",d.gca=function(e){return e={17896441:"918","935f2afb":"53","1f391b9e":"85","1476a8a4":"87",c4f5d8e4:"195","3b8c55ea":"217",e88f4f61:"243",d1ed757f:"275","786913ef":"297",a6098f0f:"383","393be207":"414","3fd9d943":"507","1be78505":"514","109f1412":"559",aa6bd851:"795","921e9125":"893",c377a04b:"971"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var n=d.p+d.u(t),f=new Error;d.l(n,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",f.name="ChunkLoadError",f.type=o,f.request=n,a[1](f)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],i=r[2],c=0;if(n.some((t=>0!==e[t]))){for(a in f)d.o(f,a)&&(d.m[a]=f[a]);if(i)var l=i(d)}for(t&&t(r);c DotSlash File Schema | DotSlash - + @@ -116,7 +116,7 @@ DotSlash file may not be in a position to change that.

In this case, setting readonly: false will disable the logic that marks all of the entries in the temporary folder read-only before it is moved to its final location in the cache.

- + \ No newline at end of file diff --git a/docs/execution/index.html b/docs/execution/index.html index 3ad59b5..9d3cac0 100644 --- a/docs/execution/index.html +++ b/docs/execution/index.html @@ -4,7 +4,7 @@ How DotSlash Works | DotSlash - + @@ -32,7 +32,7 @@ EXEC_TAKE2(<code>exec $DOTSLASH_CACHE/fe/40b2ce9a.../node --version</code>) EXEC_TAKE2 --> EXEC_SUCCEEDS - + \ No newline at end of file diff --git a/docs/flags/index.html b/docs/flags/index.html index 54f235c..df2e40b 100644 --- a/docs/flags/index.html +++ b/docs/flags/index.html @@ -4,7 +4,7 @@ Command Line Flags | DotSlash - + @@ -17,11 +17,11 @@ fairly limited.

Supported Flags

flagdescription
--helpprints basic usage info, as well as the platform it was compiled for (which is the entry it will use from the "platforms" map in a DotSlash file)
--versionprints the DotSlash version number and exits

Experimental Commands

Experimental commands are special flags that we are not committed to supporting, and whose output format should be considered unstable. These commands are "hidden" behind -- (using -- as the first argument to dotslash tells it to -use a special argument parser) and are used like so:

$ dotslash -- cache-dir
/Users/mbolin/Library/Caches/dotslash
commanddescription
b3sum FILEprints the BLAKE3 hash of FILE
cache-dirprints the absolute path to the user's DotSlash cache and exits
create-url-entry URLgenerates the DotSlash JSON snippet for the artifact at the URL
parse DOTSLASH_FILEparses DOTSLASH_FILE and prints the data as pure JSON to stdout
sha256 FILEprints the SHA-256 hash of FILE

Environment Variables

The DOTSLASH_CACHE environment variable can be used to override the default +use a special argument parser) and are used like so:

$ dotslash -- cache-dir
/Users/mbolin/Library/Caches/dotslash
commanddescription
b3sum FILEprints the BLAKE3 hash of FILE
cache-dirprints the absolute path to the user's DotSlash cache and exits
create-url-entry URLgenerates the DotSlash JSON snippet for the artifact at the URL
fetch DOTSLASH_FILEfetches the artifact identified by DOTSLASH_FILE if it is not already in the cache
parse DOTSLASH_FILEparses DOTSLASH_FILE and prints the data as pure JSON to stdout
sha256 FILEprints the SHA-256 hash of FILE

Environment Variables

The DOTSLASH_CACHE environment variable can be used to override the default location of the DotSlash cache. By default, the DotSlash cache resides at:

platformpath
Linux$XDG_CACHE_HOME/dotslash or `$HOME/.cache/dotslash
macOS$HOME/Library/Caches/dotslash
Windows{FOLDERID_LocalAppData}/dotslash

DotSlash relies on dirs::cache_dir() to use the appropriate default directory on each platform.

- + \ No newline at end of file diff --git a/docs/github/index.html b/docs/github/index.html index cd88734..4dcdb57 100644 --- a/docs/github/index.html +++ b/docs/github/index.html @@ -4,7 +4,7 @@ Generating DotSlash files Using GitHub Actions | DotSlash - + @@ -30,7 +30,7 @@ adds a generated DotSlash file with the same name to the GitHub release. This makes it possible to generate an arbitrary number of DotSlash files from a single invocation of the GitHub action.

- + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 8480d2b..4dd99e9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,7 @@ Introduction | DotSlash - + @@ -41,7 +41,7 @@ small delay while DotSlash fetches, decompresses, and verifies the appropriate .zst, but subsequent invocations should be instantaneous.

To understand what is happening under the hood, see How DotSlash Works.

- + \ No newline at end of file diff --git a/docs/installation/index.html b/docs/installation/index.html index cf99184..ab24357 100644 --- a/docs/installation/index.html +++ b/docs/installation/index.html @@ -4,7 +4,7 @@ Installing DotSlash | DotSlash - + @@ -32,7 +32,7 @@ by running a command of the form:

gh release download --repo facebook/dotslash TAG --pattern PATTERN

where TAG is the name of the release (such as v0.2.0) and PATTERN is used to match the platform that matches the artifact's name (such as '*windows*') like so:

gh release download --repo facebook/dotslash v0.2.0 --pattern '*windows*'
- + \ No newline at end of file diff --git a/docs/limitations/index.html b/docs/limitations/index.html index e6c0f62..f6d5bd1 100644 --- a/docs/limitations/index.html +++ b/docs/limitations/index.html @@ -4,7 +4,7 @@ Limitations | DotSlash - + @@ -77,7 +77,7 @@ "release" entails regenerating the DotSlash file based on the contents of dev/ and then copying everything over to release/), scenarios similar to this Thrift example are arguably not a good fit for DotSlash.

- + \ No newline at end of file diff --git a/docs/motivation/index.html b/docs/motivation/index.html index 6b99f2d..b127b54 100644 --- a/docs/motivation/index.html +++ b/docs/motivation/index.html @@ -4,7 +4,7 @@ Motivation | DotSlash - + @@ -95,7 +95,7 @@ configurable.

This system ensures that DotSlash files are regenerated regularly without human intervention and that the build artifacts delivered by DotSlash were produced in a proper build environment that should be free from human tampering.

- + \ No newline at end of file diff --git a/docs/windows/index.html b/docs/windows/index.html index 046a91c..26e8802 100644 --- a/docs/windows/index.html +++ b/docs/windows/index.html @@ -4,7 +4,7 @@ DotSlash on Windows | DotSlash - + @@ -61,7 +61,7 @@ /cygdrive/c/path/to/file to C:\path\to\file) is handled by the Cygwin shell executing DotSlash. But through layers of indirection it's possible to lose this. In this case, DotSlash does not attempt to convert the path at all.

- + \ No newline at end of file diff --git a/index.html b/index.html index c401091..9f97e87 100644 --- a/index.html +++ b/index.html @@ -4,14 +4,14 @@ DotSlash - +

DotSlash

Simplified executable deployment.

Simple

DotSlash enables you to replace a set of platform-specific, heavyweight executables with an equivalent small, easy-to-read text file.

No Overhead

DotSlash is written in Rust so it can run your executables quickly and transparently.

Painless Automation

We provide tools for generating DotSlash files for GitHub releases.

- + \ No newline at end of file diff --git a/markdown-page/index.html b/markdown-page/index.html index 67f295a..321050a 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -4,14 +4,14 @@ Markdown page example | DotSlash - +

Markdown page example

You don't need React to write simple standalone pages.

- + \ No newline at end of file