vcspull import github¶

Import repositories from GitHub or GitHub Enterprise.

Command¶

Import repositories from GitHub (github.com or GitHub Enterprise).

Usage¶

usage: vcspull import github [-h] [-w DIR] [-l LANG] [--topics TOPICS]
                             [--min-stars N] [--archived] [--forks]
                             [--limit N] [-f FILE] [--dry-run] [--yes]
                             [--json] [--ndjson] [--https] [--sync] [--prune]
                             [--prune-untracked] [--color {auto,always,never}]
                             [--token TOKEN] [-m {user,org,search}]
                             [--url URL]
                             TARGET

Positional Arguments¶

target TARGET¶

User, org name, or search query. For GitLab, supports subgroups with slash notation (e.g., parent/child).

Default: None
Required

Options¶

-w, --workspace DIR¶

Workspace root directory (REQUIRED)

Default: None

--token TOKEN¶

API token (overrides env var; prefer env var for security)

Default: None

-m, --mode¶

Import mode: user (default), org, or search

Default: user
Choices: user, org, search

--url URL¶

Base URL for GitHub Enterprise (optional)

Default: None

Filtering¶

-l, --language LANG¶

Filter by programming language

Default: None

--topics TOPICS¶

Filter by topics (comma-separated)

Default: None

--min-stars N¶

Minimum stars (for search mode)

Default: 0
Type: int

--archived¶

Include archived repositories

Default: False

--forks¶

Include forked repositories

Default: False

--limit N¶

Maximum repositories to fetch (default: 100, 0 = no limit)

Default: 100
Type: int

Output¶

-f, --file FILE¶

Config file to write to (default: ~/.vcspull.yaml)

Default: None

--dry-run, -n¶

Preview without writing to config file

Default: False

--yes, -y¶

Skip confirmation prompt

Default: False

--json¶

Output as JSON

Default: False

--ndjson¶

Output as NDJSON (one JSON per line)

Default: False

--https¶

Use HTTPS clone URLs instead of SSH (default: SSH)

Default: False

--sync¶

Sync config with remote: update URLs for existing entries whose URL has changed, and remove entries no longer on the remote. Preserves all metadata (options, remotes, shell_command_after). Respects pinned entries (options.pin.import).

Default: False

--prune¶

Remove config entries tagged by a previous import that are no longer on the remote. Does not update URLs for existing entries (use --sync for that). Implied by --sync. Respects pinned entries.

Default: False

--prune-untracked¶

With --sync or --prune, also remove config entries in the target workspace that lack import provenance (e.g. manually added repos). Entries imported from other sources and pinned entries are preserved. Requires --sync or --prune.

Default: False

--color¶

When to use colors (default: auto)

Default: auto
Choices: auto, always, never

Authentication¶

Env vars: GITHUB_TOKEN (primary), GH_TOKEN (fallback)
Token type: Personal access token (classic) or fine-grained PAT
Permissions:
- Classic PAT: no scopes needed for public repos; repo scope for private repos; read:org for org repos
- Fine-grained PAT: “Metadata: Read-only” for public; add “Contents: Read-only” for private
Create at: https://github.com/settings/tokens

Set the token:

$ export GITHUB_TOKEN=ghp_...

Then import:

$ vcspull import gh myuser --workspace ~/code/