tiged-tool

Files (2)

• SKILL.md
• actions.md · references/

SKILL.md (first lines)

# tiged-tool

Project Scaffolding and Repo Inspection

- Homepage: <https://github.com/tiged/tiged>
- Version: tiged v2.12.7
- This document is generated by deepseek-v4-flash

## When to use tiged vs git clone

Default to **tiged** when the task needs repository files but not a Git repository. A shallow clone still creates `.git` metadata and a configured remote, so `git clone --depth 1` is not a substitute for a history-free snapshot.

Use tiged for:

- **Reading or browsing code**: you just want to inspect a repo locally, not contribute back.
- **Starting a new project from a template**: no `.git` folder means your copy is clean and ready for `git init` as your own project.
- **Repeat downloads**: tiged caches tarballs by commit hash, so pulling the same ref again is instant (no re-fetch).

Use **git clone** when the user explicitly requests it or the task needs Git behavior such as fetching updates, switching branches, inspecting history, preserving submodules, or contributing upstream.

## Quick start

```bash
npx tiged user/repo             # download into a folder named after the repo
npx tiged user/repo .           # download into the current directory
npx tiged user/repo my-app      # download into my-app/
```

`bunx tiged` should work the same way as `npx tiged`.

## Source platforms

| Platform    | Prefix          | Example                                           |
|------------|-----------------|---------------------------------------------------|
| GitHub     | `github:` (default) | `npx tiged user/repo`                         |
| GitLab     | `gitlab:`        | `npx tiged gitlab:user/repo`                     |
| BitBucket  | `bitbucket:`     | `npx tiged bitbucket:user/repo`                  |
| Sourcehut  | (none)           | `npx tiged git.sr.ht/~user/repo`                 |
| HuggingFace| `huggingface:`   | `npx tiged huggingface:user/repo`                |
| Codeberg   | `codeberg:`      | `npx tiged codeberg:user/repo`                   |

SSH-style (`git@host:user/repo`) and full HTTPS URLs work for all platforms.

## Specifying a version

```bash
npx tiged user/repo#dev       # branch
npx tiged user/repo#v1.2.3    # tag
npx tiged user/repo#abc1234   # commit hash
```

## Cloning a subdirectory

```bash
npx tiged user/repo/subdirectory
```

Only the contents of that subdirectory are extracted; the rest of the repo is ignored.

## Options

| Flag | Purpose |
|------|---------|
| `--disable-cache` | Skip the cache; always download fresh |
| `--offline-mode` | Never hit the network; only use cached tarballs |
| `--mode=git` | Clone via SSH instead of downloading a tarball (required for private repos; slower) |
| `--subgroup` (`-s`) | Resolve GitLab repos that live inside a subgroup |
| `--sub-directory` | Combine with `--subgroup` to extract a subdirectory from a subgroup repo |
| `--force` (`-f`) | Overwrite existing files in the destination |

If you expect an option that is missing here, check `npx tiged --help`; it may exist but is too niche to include.

## Troubleshooting

### `zlib: unexpected end of file`

A corrupt cached tarball. Fix:

```bash
npx tiged --disable-cache user/repo        # one-time workaround
```

To clear the cache entirely, remove the cache directory (platform-specific paths: see homepage).

### GitLab repo not found

If the repo lives inside a GitLab subgroup, use `--subgroup`:

```bash
npx tiged --subgroup gitlab:org/group/subgroup/repo
```

### Private repo fails

Private repos must be cloned via SSH, not tarball:

```bash
npx tiged --mode=git user/private-repo
```

You need your SSH key configured on the host beforehand.

### Destination not empty

Use `--force` to overwrite:

```bash
npx tiged --force user/repo .
```

## Actions (`degit.json`)

tiged supports post-clone actions (running additional clones or removing files) via a `degit.json` file placed at the repo root. See `references/actions.md` for the full reference.

## Further reference

The homepage covers details this skill intentionally omits to stay lean. Only consult it when you genuinely need information NOT already in this skill, such as:

- Cache directory paths per platform (macOS / Windows / Linux)

From Cologler/Skills, MIT.

More from Cologler/Skills