Skip to content

CLI: Delete repo #1486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 79 additions & 5 deletions packages/hub/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { parseArgs } from "node:util";
import { typedEntries } from "./src/utils/typedEntries";
import { createBranch, createRepo, deleteBranch, repoExists, uploadFilesWithProgress } from "./src";
import { createBranch, createRepo, deleteBranch, deleteRepo, repoExists, uploadFilesWithProgress } from "./src";
import { pathToFileURL } from "node:url";
import { stat } from "node:fs/promises";
import { basename, join } from "node:path";
Expand Down Expand Up @@ -78,7 +78,6 @@ const commands = {
{
name: "repo-type" as const,
enum: ["dataset", "model", "space"],
default: "model",
description:
"The type of repo to upload to. Defaults to model. You can also prefix the repo name with the type, e.g. datasets/username/repo-name",
},
Expand Down Expand Up @@ -126,9 +125,8 @@ const commands = {
{
name: "repo-type" as const,
enum: ["dataset", "model", "space"],
default: "model",
description:
"The type of repo to create. Defaults to model. You can also prefix the repo name with the type, e.g. datasets/username/repo-name",
"The type of the repo to create the branch into. Defaults to model. You can also prefix the repo name with the type, e.g. datasets/username/repo-name",
},
{
name: "revision" as const,
Expand Down Expand Up @@ -173,7 +171,6 @@ const commands = {
{
name: "repo-type" as const,
enum: ["dataset", "model", "space"],
default: "model",
description:
"The type of repo to delete the branch from. Defaults to model. You can also prefix the repo name with the type, e.g. datasets/username/repo-name",
},
Expand All @@ -187,6 +184,35 @@ const commands = {
},
},
} satisfies CommandGroup,
repo: {
description: "Manage repositories on the Hub",
subcommands: {
delete: {
description: "Delete a repository from the Hub",
args: [
{
name: "repo-name" as const,
description:
"The name of the repo to delete. You can also prefix the repo name with the type, e.g. datasets/username/repo-name",
positional: true,
required: true,
},
{
name: "repo-type" as const,
enum: ["dataset", "model", "space"],
description:
"The type of the repo to delete. Defaults to model. You can also prefix the repo name with the type, e.g. datasets/username/repo-name",
},
{
name: "token" as const,
description:
"The access token to use for authentication. If not provided, the HF_TOKEN environment variable will be used.",
default: process.env.HF_TOKEN,
},
] as const,
},
},
} satisfies CommandGroup,
version: {
description: "Print the version of the CLI",
args: [] as const,
Expand Down Expand Up @@ -389,6 +415,54 @@ async function run() {
}
break;
}
case "repo": {
const repoCommandGroup = commands.repo;
const currentSubCommandName = subCommandName as keyof typeof repoCommandGroup.subcommands | undefined;

if (cliArgs[0] === "--help" || cliArgs[0] === "-h") {
if (currentSubCommandName && repoCommandGroup.subcommands[currentSubCommandName]) {
console.log(detailedUsageForSubcommand("repo", currentSubCommandName));
} else {
console.log(listSubcommands("repo", repoCommandGroup));
}
break;
}

if (!currentSubCommandName || !repoCommandGroup.subcommands[currentSubCommandName]) {
console.error(`Error: Missing or invalid subcommand for 'repo'.`);
console.log(listSubcommands("repo", repoCommandGroup));
process.exitCode = 1;
break;
}

const subCmdDef = repoCommandGroup.subcommands[currentSubCommandName];

switch (currentSubCommandName) {
case "delete": {
const parsedArgs = advParseArgs(cliArgs, subCmdDef.args, `repo ${currentSubCommandName}`);
const { repoName, repoType, token } = parsedArgs;

const repoDesignation: Parameters<typeof deleteRepo>[0]["repo"] = repoType
? { type: repoType as "model" | "dataset" | "space", name: repoName }
: repoName;

await deleteRepo({
repo: repoDesignation,
accessToken: token,
hubUrl: process.env.HF_ENDPOINT ?? HUB_URL,
});
console.log(`Repository '${repoName}' deleted successfully.`);
break;
}
default:
// This case should ideally be caught by the check above
console.error(`Error: Unknown subcommand '${currentSubCommandName}' for 'repo'.`);
console.log(listSubcommands("repo", repoCommandGroup));
process.exitCode = 1;
break;
}
break;
}
case "version": {
if (cliArgs[0] === "--help" || cliArgs[0] === "-h") {
console.log(detailedUsageForCommand("version"));
Expand Down