repos.files.get

GET

api

repos

{repo_name}

file

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const file = await pierre.repos.files.get({
  repo_name: 'my-demo-repository',
  ephemeral: true,
  path: 'src/main.js',
  ref: 'v1.0.0',
});
console.log((await file.arrayBuffer()).byteLength);

from pierre import Pierre

# The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
pierre = Pierre()

file = pierre.repos.files.get(
    repo_name="my-demo-repository",
    ephemeral=True,
    path="src/main.js",
    ref="v1.0.0",
)
print(len(file.read()))
file.close()

import (
	"context"
	"fmt"
	"io"

	pierre "github.com/pierrecomputer/sdk/go"
)

ctx := context.Background()
// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
client, err := pierre.NewClient()
if err != nil {
	return err
}
file, err := client.Repos.Files.Get(ctx, pierre.ReposFilesGetParams{
	RepoName:  "my-demo-repository",
	Ephemeral: pierre.Bool(true),
	Path:      "src/main.js",
	Ref:       pierre.String("v1.0.0"),
})
if err != nil {
	return err
}
defer file.Close()
data, err := io.ReadAll(file)
if err != nil {
	return err
}
fmt.Println(len(data))

"<string>"

"<string>"

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Scopes

git:read

Headers

Range

string

Standard HTTP byte-range header (bytes=<start>-<end>). Triggers a 206 Partial Content response.

If-Range

string

Conditional range request: when the supplied validator matches ETag or Last-Modified, the server returns 206 Partial Content; otherwise the full body is returned with 200 OK.

If-Match

string

Returns 412 Precondition Failed when the current ETag does not match.

If-None-Match

string

Returns 304 Not Modified when the current ETag matches.

If-Modified-Since

string

Returns 304 Not Modified when Last-Modified is on or before this date.

If-Unmodified-Since

string

Returns 412 Precondition Failed when Last-Modified is after this date.

Path Parameters

repo_name

string

required

The repository name, for example acme/web.

Query Parameters

path

string

required

Repository-relative file path to fetch.

ref

string

Optional branch, tag, or commit SHA to read from. When omitted, the repository default branch is used.

ephemeral

boolean

Whether ref should be resolved from the ephemeral namespace.

Response

File content returned.

Raw file bytes exactly as stored in the Git blob. No transcoding or encoding is applied.

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const file = await pierre.repos.files.get({
  repo_name: 'my-demo-repository',
  ephemeral: true,
  path: 'src/main.js',
  ref: 'v1.0.0',
});
console.log((await file.arrayBuffer()).byteLength);

from pierre import Pierre

# The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
pierre = Pierre()

file = pierre.repos.files.get(
    repo_name="my-demo-repository",
    ephemeral=True,
    path="src/main.js",
    ref="v1.0.0",
)
print(len(file.read()))
file.close()

import (
	"context"
	"fmt"
	"io"

	pierre "github.com/pierrecomputer/sdk/go"
)

ctx := context.Background()
// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
client, err := pierre.NewClient()
if err != nil {
	return err
}
file, err := client.Repos.Files.Get(ctx, pierre.ReposFilesGetParams{
	RepoName:  "my-demo-repository",
	Ephemeral: pierre.Bool(true),
	Path:      "src/main.js",
	Ref:       pierre.String("v1.0.0"),
})
if err != nil {
	return err
}
defer file.Close()
data, err := io.ReadAll(file)
if err != nil {
	return err
}
fmt.Println(len(data))

"<string>"

"<string>"

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Getting Started

Platform

Workflows

Libraries

API Reference

Authorizations

Scopes

Headers

Path Parameters

Query Parameters

Response