CLI reference

hackerrank

Manage HackerRank uploads, prompts and the complete API.

Usage

hackerrank [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

api

Call every documented v3, ATS and SCIM operation.

Usage

hackerrank api [OPTIONS] COMMAND [ARGS]...

call

Execute OPERATION and print status, headers and complete JSON data.

Usage

hackerrank api call [OPTIONS] OPERATION

Options

--path <path_json>

JSON object of path parameters.

--query <query_json>

JSON object of query fields; arrays use CSV encoding.

--body-file <body_file>

JSON request body file, or - for stdin.

--dry-run

Validate without credentials or network access.

Arguments

OPERATION

Required argument

describe

Show an operation’s parameters, body schema and referenced definitions.

Usage

hackerrank api describe [OPTIONS] OPERATION

Arguments

OPERATION

Required argument

operations

List operation names, methods, paths and summaries without credentials.

Usage

hackerrank api operations [OPTIONS]

questions

Manage project-question starter files and AI prompts.

Usage

hackerrank questions [OPTIONS] COMMAND [ARGS]...

archive

Export a project ZIP without credentials or network access.

Usage

hackerrank questions archive [OPTIONS]

Options

--directory <directory>

Project directory.

--file <source_file>

One starter file, packaged as a single-file project archive.

--configuration-file <configuration_file>

Native project configuration to add or replace at the archive root.

--exclude <exclude>

Additional Gitignore pattern at the upload root. Repeatable.

--output <output>

Required New ZIP file, or - for binary standard output. Never overwrites files.

set-system-prompt

Set the AI system prompt on an existing project question.

Usage

hackerrank questions set-system-prompt [OPTIONS] QUESTION_ID

Options

--prompt-file <prompt_file>

Required UTF-8 system prompt, up to 15,000 characters. An empty file clears it.

--dry-run

Validate the prompt without credentials or network access.

Arguments

QUESTION_ID

Required argument

upload

Replace project starter files while preserving question metadata.

Usage

hackerrank questions upload [OPTIONS] QUESTION_ID

Options

--directory <directory>

Project directory.

--file <source_file>

One starter file, uploaded as a single-file project archive.

--configuration-file <configuration_file>

Native project configuration to add or replace at the archive root.

--exclude <exclude>

Additional Gitignore pattern at the upload root. Repeatable.

--dry-run

Validate and list files without credentials or network access.

--retries <retries>

Retry count delegated to the SDK for this repeatable upload.

Default:

0

Arguments

QUESTION_ID

Required argument