mirror of
https://github.com/tiktok/sparo.git
synced 2024-12-11 16:21:19 -05:00
1 line
15 KiB
JavaScript
1 line
15 KiB
JavaScript
|
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[270],{7356:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>n,default:()=>a,frontMatter:()=>c,metadata:()=>d,toc:()=>h});var i=s(678),r=s(4738);const c={title:"Overview"},n=void 0,d={id:"pages/commands/overview",title:"Overview",description:"The git command-line tool supports various subcommands such as git clone, git checkout, and so forth. The sparo command-line is intended to be a complete replacement for git.",source:"@site/docs/pages/commands/overview.md",sourceDirName:"pages/commands",slug:"/pages/commands/overview",permalink:"/sparo/pages/commands/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/tiktok/sparo/tree/main/apps/website/docs/pages/commands/overview.md",tags:[],version:"current",frontMatter:{title:"Overview"},sidebar:"docsSidebar",previous:{title:"<profile-name>.json",permalink:"/sparo/pages/configs/profile_json"},next:{title:"sparo auto-config",permalink:"/sparo/pages/commands/sparo_auto-config"}},o={},h=[{value:"Mirrored commands",id:"mirrored-commands",level:2}];function l(e){const t={a:"a",code:"code",em:"em",h2:"h2",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"git"})," command-line tool supports various subcommands such as ",(0,i.jsx)(t.code,{children:"git clone"}),", ",(0,i.jsx)(t.code,{children:"git checkout"}),", and so forth. The ",(0,i.jsx)(t.code,{children:"sparo"})," command-line is intended to be a complete replacement for ",(0,i.jsx)(t.code,{children:"git"}),"."]}),"\n",(0,i.jsx)(t.p,{children:"Sparo has four kinds of subcommands:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Mirrored subcommands"})," such as ",(0,i.jsx)(t.code,{children:"sparo branch"})," and ",(0,i.jsx)(t.code,{children:"sparo revert"})," directly invoke the corresponding ",(0,i.jsx)(t.code,{children:"git"})," version of that subcommand. The motivation for using mirrored subcommands is to enable Sparo to provide advice about parameters that may cause performance issues. Additionally, you can optionally configure Sparo to collect anonymized usage metrics to help you measure the experience in your repository. (Collected data is sent to your own service. It is not accessible by any other party.)"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Enhanced subcommands"})," follow the same basic design as their ",(0,i.jsx)(t.code,{children:"git"})," counterparts, but with adaptations for sparse checkout profiles and more efficient defaults. There are four enhanced commands:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo checkout"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo clone"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo fetch"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo pull"})}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Renamed subcommands"})," are the mirrored versions of the four enhanced subcommands. They are renamed to add a ",(0,i.jsx)(t.code,{children:"git-"})," prefix:"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo git-checkout"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo git-clone"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo git-fetch"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.code,{children:"sparo git-pull"})}),"\n"]}),"\n",(0,i.jsxs)(t.ol,{start:"4",children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.strong,{children:"Auxiliary subcommands"})," are new subcommands that provide Sparo-specific functionality. They are:"]}),"\n"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{c
|