šŸš€ Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Socket
DemoInstallSign in
Socket

create-defuss

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

create-defuss

Checks out git projects from sub-directories. Originally for jump-starting defuss projects from templates.

1.0.10
latest
Source
npm
Version published
Weekly downloads
78
-50.94%
Maintainers
1
Weekly downloads
Ā 
Created
Source

defuss

Project Scaffolder

create-defuss is a simple, lightweight CLI tool and Node.js library that enables Git sparse checkouts for subdirectories of GitHub repositories. Originally created to help jump-start projects using defuss templates, it can be used for any Git repository.

šŸ’” Did you know? With just one command, you can checkout a specific subdirectory from a GitHub repository without cloning the entire project.

šŸš€ Getting Started

You're just one step away from checking out one of defuss simple example projects:

Create a new defuss + Astro project:

[ā€¼ļø] Make sure git is installed on your computer!

npx create-defuss https://github.com/kyr0/defuss/tree/main/examples/with-astro-ts

This will download only the code from the with-astro-ts subdirectory into the (new) folder local folder.

Create a new defuss + Vite project:

[ā€¼ļø] Make sure git is installed on your computer!

npx create-defuss https://github.com/kyr0/defuss/tree/main/examples/with-vite-ts

This will download only the code from the with-vite-ts subdirectory into the (new) folder local folder.

Downloading into a custom local folder

npx create-defuss https://github.com/kyr0/defuss/tree/main/examples/with-vite-ts ./my-custom-defuss-project

This will download only the code from the with-vite-ts subdirectory into the (new) folder local folder my-custom-defuss-project.

āš™ļø API usage

You can also use create-defuss as library. It's super simple:

import { performSparseCheckout } from "create-defuss"

// pass in the Git url and desired destination folder (relative to the current working directory)
performSparseCheckout("git_url", "dest_folder")

šŸš€ How does defuss-vite work?

create-defuss is an NPM package with a bin entry in package.json. This, combined with a "shebang" line (#!/someshell) makes it executable using npx as a CLI (command line interface). It uses Git sparse checkout to efficiently download files from a specific subdirectory of a GitHub repository. It avoids downloading the entire repository, saving bandwidth and time. Also, monorepo maintainers can spare on creating extra "template" repositories for their example code.

Inside the project, you'll find the following relevant files:

/
ā”œā”€ā”€ src/cli.ts
ā”œā”€ā”€ src/git.ts
ā”œā”€ā”€ package.json

šŸ§ž Commands

All commands are run from the root of the project, from a terminal:

CommandAction
npm buildBuild a new version of the plugin.
npm publishPublish a new version of the defuss-vite integration package.
Come visit us on defuss island!

Keywords

git

FAQs

Package last updated on 28 May 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts