curseforge-upload-api
v0.1.0
Published
Typed CurseForge Author and Studios/Core publishing client for Node.js
Readme
curseforge-upload-api
Typed ESM client for CurseForge Author publishing operations and selected Studios/Core publication lookups. Requires Node.js 22 or newer.
npm install curseforge-upload-apiMinimal upload
import { CurseForgeAuthorClient } from "curseforge-upload-api";
const author = new CurseForgeAuthorClient({
token: process.env.CURSEFORGE_API_TOKEN!,
});
const result = await author.files.upload({
projectId: 123456,
file: { path: "build/libs/example.jar" },
changelog: "Release notes",
changelogType: "markdown",
gameVersionNames: ["1.21.1", "NeoForge"],
releaseType: "release",
});
console.log(result.id);Create CurseForgeCoreClient separately with CURSEFORGE_CORE_API_KEY for optional Core lookups.
The Author token and Core API key are not interchangeable.
The Author client exposes file upload/update, Author game metadata, localization import/export, Maven retrieval, and packaging compatibility operations. The Core client exposes games, projects, and published-file lookups. Unsafe Author mutations do not retry automatically; inspect CurseForge before retrying an ambiguous failure.
Read the repository documentation, complete
endpoint reference, and security guide. Source
is hosted at https://github.com/AlmanaX-21/curseforge-upload; the npm package is not published
yet.
MIT licensed. See LICENSE.
