Quick start

This guide starts after GitHub NetDisk is installed and running.

Tip

Not installed yet? Go to Download & Install.

1. Connect GitHub or continue read-only

On first launch, choose how you want to access repositories:

• Connect with GitHub App (recommended): the app copies a one-time code and opens GitHub in your browser. Enter the code, install the GitHub App, and select the repositories GitHub NetDisk may access.
• Continue in read-only mode: browse compatible public repositories without uploading or changing files.
• Personal Access Token (advanced): use this only for compatibility or troubleshooting when GitHub App authorization is unavailable.

Credentials are stored in the operating-system credential vault. You can connect, reconnect, change repository access, or sign out later from Account.

2. Add a repository

Open Home and select Add repository. You can:

• Create a new cloud-drive repository.
• Add an existing compatible repository with its full owner/repository name.

Creating a repository requires sign-in. New repositories receive the required netdisk.json structure automatically.

To open a repository without adding it to Home, use Browse, enter owner/repository, choose a branch, and select Open. A compatible repository must contain netdisk.json on that branch.

3. Browse and manage files

The Browse toolbar lets you upload, download, save as, rename, and delete files, create folders, refresh the listing, and download a folder recursively.

For a file, Generate link creates a shareable GitHub NetDisk download page. Generate direct link is available only when the file uses one Release asset and is smaller than 1.9 GiB.

Public repositories can be browsed without signing in. Changes require an account with write access to that repository.

4. Follow transfers

Open Tasks to see downloads, uploads, completed jobs, and failures. You can pause, resume, or cancel a transfer, remove old records, and show a completed download in its folder.

Large files are split or reassembled automatically. Completed downloads are checked with SHA-256, and a resumed upload can reuse parts already present on GitHub when its source file has not changed.

5. Adjust the app

Open Settings to configure:

• Theme, Mica effect, interface language, and zoom.
• System-tray behavior and whether closing the main window quits the app.
• Folders-first sorting and the default download location.
• aria2 and its executable path.
• Fastest-mirror selection for public-repository downloads.
• Automatic update checks.

Application links

Installed builds register github-netdisk://. Supported links can open a repository or prepare a transfer. GitHub NetDisk shows the decoded values and asks for confirmation before starting a task.

github-netdisk://new-task/download/repo/?uri=owner/repo@branch/path/to/file&filename=file.bin
github-netdisk://new-task/upload/url/?uri=https%3A%2F%2Fexample.com%2Fupload&filename=/local/file.bin
github-netdisk://browse-repo/?repo=owner/repo&branch=main