Working Copy

Working Copy is a powerful Git client for iOS that clones, edits, commits, pushes and more. Protocol Launcher allows you to generate deep links to perform Git operations in Working Copy.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Simple Commands

Open

Open Working Copy app.

On-Demand

import { open } from 'protocol-launcher/working-copy'

const url = open()

Open Working Copy

Clone

Ask Working Copy to open the clone dialog with a specific URL.

On-Demand

import { clone } from 'protocol-launcher/working-copy'

const url = clone({
  remote: 'https://github.com/zhensherlock/watermark-js-plus.git',
})

Clone Repository

Show

Show a remote repository inside Working Copy, cloning as needed.

On-Demand

import { show } from 'protocol-launcher/working-copy'

const url = show({
  remote: 'https://github.com/zhensherlock/watermark-js-plus.git',
})

Show Repository

Open Screen

Open Working Copy at a specific screen.

On-Demand

import { openScreen } from 'protocol-launcher/working-copy'

const url = openScreen({
  repo: 'my project',
  path: 'README.md',
  mode: 'content',
})

Open Screen

Import Log

Import and show log files in Working Copy.

On-Demand

import { importLog } from 'protocol-launcher/working-copy'

const url = importLog({
  lines: 'first line\nsecond line',
})

Import Log

X-Callback-URL Commands

Checkout

Checkout (switch) branch in Working Copy.

On-Demand

import { checkout } from 'protocol-launcher/working-copy'

const url = checkout({
  key: '123ABC',
  repo: 'my repo',
  branch: 'develop',
})

Checkout Branch

Commit

Commit changes in Working Copy.

On-Demand

import { commit } from 'protocol-launcher/working-copy'

const url = commit({
  key: '123ABC',
  repo: 'my repo',
  path: '',
  limit: 999,
  message: 'fix',
})

Commit Changes

Push

Push commits to remote repository.

On-Demand

import { push } from 'protocol-launcher/working-copy'

const url = push({
  key: '123ABC',
  repo: 'my repo',
})

Push Commits

Pull

Pull (fetch and merge) from remote repository.

On-Demand

import { pull } from 'protocol-launcher/working-copy'

const url = pull({
  key: '123ABC',
  repo: 'my repo',
})

Pull Changes

Fetch

Fetch from remote repository.

On-Demand

import { fetch } from 'protocol-launcher/working-copy'

const url = fetch({
  key: '123ABC',
  repo: 'my repo',
})

Fetch Remote

Status

List file status in Working Copy.

On-Demand

import { status } from 'protocol-launcher/working-copy'

const url = status({
  key: '123ABC',
  repo: 'my repo',
  unchanged: true,
})

Check Status

Log

Get commit log from Working Copy.

On-Demand

import { log } from 'protocol-launcher/working-copy'

const url = log({
  key: '123ABC',
  repo: 'my repo',
})

View Commit Log

Branches

List all local and remote branches in a repository.

On-Demand

import { branches } from 'protocol-launcher/working-copy'

const url = branches({
  key: '123ABC',
  repo: 'my repo',
})

List Branches

Merge

Merge branches in Working Copy.

On-Demand

import { merge } from 'protocol-launcher/working-copy'

const url = merge({
  key: '123ABC',
  repo: 'my repo',
  branch: 'develop',
})

Merge Branch

Delete Branch

Delete a branch in Working Copy.

On-Demand

import { deleteBranch } from 'protocol-launcher/working-copy'

const url = deleteBranch({
  key: '123ABC',
  repo: 'my repo',
  branch: 'develop',
})

Delete Branch

Init

Initialize a new empty repository.

On-Demand

import { init } from 'protocol-launcher/working-copy'

const url = init({
  key: '123ABC',
  name: 'new repository',
})

Init Repository

Repos

List all repositories in Working Copy.

On-Demand

import { repos } from 'protocol-launcher/working-copy'

const url = repos({
  key: '123ABC',
})

List Repositories

Move

Move or rename files within a repository.

On-Demand

import { move } from 'protocol-launcher/working-copy'

const url = move({
  key: '123ABC',
  repo: 'my repo',
  source: 'from.txt',
  destination: 'to.txt',
})

Move File

Read

Read contents of text files from Working Copy.

On-Demand

import { read } from 'protocol-launcher/working-copy'

const url = read({
  key: '123ABC',
  xSuccess: 'app://x-callback-url/read?text=',
  repo: 'my repo',
  path: 'README.md',
})

Read File

Write

Write to existing or new files in Working Copy.

On-Demand

import { write } from 'protocol-launcher/working-copy'

const url = write({
  key: '123ABC',
  repo: 'my repo',
  path: 'README.md',
  text: 'hello there',
})

Write File

Zip

Archive multiple files as a base64-coded zip.

On-Demand

import { zip } from 'protocol-launcher/working-copy'

const url = zip({
  key: '123ABC',
  xSuccess: 'my-app://x-callback-url/read?path=/',
  repo: 'my repo',
})

Create Zip Archive

SSH Command

Run secure shell command on remote server.

On-Demand

import { sshCommand } from 'protocol-launcher/working-copy'

const url = sshCommand({
  key: '123ABC',
  server: 'remote.server.net',
  cmd: 'run tests',
})

Run SSH Command

WebDAV

Start or stop the internal WebDAV server.

On-Demand

import { webdav } from 'protocol-launcher/working-copy'

const url = webdav({
  key: '123ABC',
  cmd: 'start',
})

Toggle WebDAV

Chain

Chain multiple x-callback-url commands together.

On-Demand

import { chain } from 'protocol-launcher/working-copy'

const url = chain({
  key: '123ABC',
  repo: 'my repo',
  commands: [
    { command: 'commit', params: { message: 'fix' } },
    { command: 'push' },
  ],
})

Chain Commands