본문 바로가기
WIKI 기술 지식 베이스

lakectl

원문 보기 위키 갱신

lakectl (lakeFS Enterprise 커맨드라인 도구)

lakectl은 lakeFS의 공식 CLI 도구예요. lakeFS Enterprise의 lakectl은 테넌트(tenant) 관리, 브랜치/오브젝트 라이프사이클 정책, 웹 브라우저 로그인 등 Enterprise 기능이 포함된 명령 레퍼런스를 제공해요. 저장소·브랜치·태그·오브젝트 관리부터 인증, 가비지 컬렉션 정책, 로컬 동기화까지 명령줄에서 다룰 수 있어요.

출처: 문서

본문

Note

이 파일(cli.md)은 cmd/lakectl 아래의 Go 코드 파일들에서 자동 생성돼요. Markdown 파일을 직접 수정하면 덮어써지므로, 변경은 관련 Go 파일에서 해야 해요.

lakectl을 로컬에 설치하기

lakectl은 Linux, macOS, Windows에서 사용할 수 있어요. Docker로 실행할 수도 있어요.

lakectl 다운로드

또는 Linux/macOS에서는 Homebrew를 사용해요:

brew tap treeverse/lakefs
brew install lakefs-enterprise

자격 증명과 API 엔드포인트 설정

lakectl 명령을 설치한 뒤 다음을 실행해요:

lakectl config
# output:
# Config file /home/janedoe/.lakectl.yaml will be used
# Access key ID: «redacted:AKIA…»
# Secret access key: ****************************************
# Server endpoint URL: http://localhost:8000

이렇게 하면 여러분이 입력한 자격 증명과 API 엔드포인트로 $HOME/.lakectl.yaml 파일이 만들어져요. 새 설치를 세팅하고 초기 자격 증명을 만들 때(Quickstart 참고), UI가 미리 구성된 설정 파일을 내려받을 수 있는 링크를 제공해요.

lakectl 설정

lakectl은 YAML 파일(기본 경로 ~/.lakectl.yaml, --config 또는 LAKECTL_CONFIG_FILE로 재정의 가능)과 환경 변수에서 설정을 읽어요.

  • 모든 설정 키는 LAKECTL_<대문자_키_이며_점은_밑줄로_대체> 패턴의 환경 변수로 제공할 수 있어요.

  • 명령줄 플래그로 준 값이 설정 파일의 값을 이기고, 설정 파일의 값은 다시 환경 변수로 준 값을 이겨요.

레퍼런스

  • credentials.access_key_id (string : required) - lakeFS에 인증할 때 쓰는 액세스 키 ID예요.

  • credentials.secret_access_key (string : required) - 액세스 키 ID와 짝을 이루는 시크릿 액세스 키예요.

  • credentials.provider.type (string : "") - Enterprise 전용. AWS IAM에서 임시 자격 증명을 받으려면 aws_iam으로, 정적 자격 증명(기본값)에는 빈 값으로 설정해요.

  • credentials.provider.aws_iam.token_ttl_seconds (duration : 6h) - 생성된 lakeFS 토큰의 수명이에요.

  • credentials.provider.aws_iam.url_presign_ttl_seconds (duration : 1m) - lakectl이 만드는 pre-signed URL의 TTL이에요.

  • credentials.provider.aws_iam.refresh_interval (duration : 5m) - lakectl이 IAM 자격 증명을 새로 고치는 주기예요.

  • credentials.provider.aws_iam.token_request_headers (map[string]string : {}) - 토큰을 요청할 때 포함할 추가 HTTP 헤더예요.

  • network.http2.enabled (bool : true) - API 클라이언트에 HTTP/2를 활성화해요.

  • server.endpoint_url (string : http://127.0.0.1:8000 `) - lakeFS 서버의 베이스 URL이에요.

  • server.retries.enabled (bool : true) - lakectl이 한 번 이상 재시도할지 여부예요.

  • server.retries.max_attempts (uint : 4) - 요청당 최대 시도 횟수예요.

  • server.retries.min_wait_interval (duration : 200ms) - 재시도 사이 최소 백오프예요.

  • server.retries.max_wait_interval (duration : 30s) - 재시도 사이 최대 백오프예요.

  • options.parallelism (int : 25) - I/O 작업(업로드, 다운로드 등)의 기본 동시성 수준이에요.

  • local.skip_non_regular_files (bool : false) - true이면 lakectl local 작업 중 심볼릭 링크 등 비정규 파일을 오류 대신 건너뛰어요.

  • experimental.local.posix_permissions.enabled (bool : false) - 파일 동기화 시 POSIX 권한을 보존해요.

  • experimental.local.posix_permissions.include_uid (bool : false) - 저장되는 메타데이터에 UID를 포함해요.

  • experimental.local.posix_permissions.include_gid (bool : false) - 저장되는 메타데이터에 GID를 포함해요.

Docker에서 lakectl 실행하기

lakectl을 Docker 컨테이너에서 실행하고 싶다면, 설정 요소를 환경 변수로 넘겨서 실행하면 돼요. 예제예요:

docker run --rm --pull always \
          -e LAKECTL_CREDENTIALS_ACCESS_KEY_ID=«redacted:AKIA…» \
          -e LAKECTL_CREDENTIALS_SECRET_ACCESS_KEY=xxxxx
          -e LAKECTL_SERVER_ENDPOINT_URL=https://host.us-east-2.lakefscloud.io/ \
          --entrypoint lakectl treeverse/lakefs-enterprise \
          repo list

lakeFS 자체를 로컬에서 실행 중이라면 Docker 컨테이너의 네트워킹 설정에서 이를 반영해야 해요. 다시 말해 Docker 컨테이너에게 localhost는 컨테이너 자신이지, 실행 중인 호스트 머신이 아니에요.

명령 레퍼런스

lakectl

lakeFS를 탐색·관리·작업하기 위한 CLI 도구

Synopsis

lakectl은 lakeFS 환경을 탐색하고 조작할 수 있게 해주는 CLI 도구예요.

플러그인으로 확장할 수 있어요. 자세한 내용은 'lakectl plugin --help'를 보세요.

lakectl [flags]

Options

      --base-uri string      base URI used for lakeFS address parse
  -c, --config string        config file (default is $HOME/.lakectl.yaml)
  -h, --help                 help for lakectl
      --log-format string    set logging output format
      --log-level string     set logging level (default "none")
      --log-output strings   set logging output(s)
      --no-color             don't use fancy output colors (default value can be set by NO_COLOR environment variable)
      --tenant string        active tenant name; 'root' overrides a configured default (default $LAKEFS_DEFAULT_TENANT, then the 'tenant' configuration key)
      --verbose              run in verbose mode
  -v, --version              version for lakectl

Note

base-uri 옵션은 LAKECTL_BASE_URI 환경 변수로 제어할 수 있어요.

사용 예제

$ export LAKECTL_BASE_URI="lakefs://my-repo/my-branch"
# Once set, use relative lakefs uri's:
$ lakectl fs ls /path

lakectl actions

Actions 명령 관리

Options

  -h, --help   help for actions

lakectl actions help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 actions help [명령 경로]처럼 입력하세요.

lakectl actions help [command] [flags]

Options

  -h, --help   help for help

lakectl actions runs

실행(run) 정보 탐색

Options

  -h, --help   help for runs

lakectl actions runs describe

실행 결과 설명

Synopsis

실행(run)과 그 실행의 일부로 수행된 모든 훅에 대한 정보를 보여줘요

lakectl actions runs describe <repository URI> <run_id> [flags]

Examples

lakectl actions runs describe lakefs://my-repo 20230719152411arS0z6I

Options

      --after string   show results after this value (used for pagination)
      --amount int     number of results to return. By default, all results are returned.
  -h, --help           help for describe

lakectl actions runs help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 runs help [명령 경로]처럼 입력하세요.

lakectl actions runs help [command] [flags]

Options

  -h, --help   help for help

lakectl actions runs list

실행 목록

Synopsis

저장소의 모든 실행을 나열하되, 브랜치나 커밋으로 필터링할 수 있어요

lakectl actions runs list <repository URI> [--branch <branch>] [--commit <commit_id>] [flags]

Examples

lakectl actions runs list lakefs://my-repo --branch my-branch --commit 600dc0ffee

Options

      --branch string   show results for specific branch
      --commit string   show results for specific commit ID
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
  -h, --help            help for list

lakectl actions validate

액션 파일 검증

Synopsis

입력 액션 파일을 lakeFS 액션 파일로 파싱해 봐요

lakectl actions validate [flags]

Examples

lakectl actions validate path/to/my/file

Options

  -h, --help   help for validate

lakectl annotate

주어진 경로 아래 항목을 나열하고, 각 항목에 가장 최근 수정 커밋을 표기해요

lakectl annotate <path URI> [flags]

Options

      --first-parent   follow only the first parent commit upon seeing a merge commit
  -h, --help           help for annotate
  -r, --recursive      recursively annotate all entries under a given path or prefix

lakectl auth

인증과 권한 관리

Synopsis

사용자, 그룹, ACL을 포함해 인증과 권한을 관리해요. 이 기능은 외부 인증 서비스에서만 지원돼요.

Options

  -h, --help   help for auth

lakectl auth groups

그룹 관리

Options

  -h, --help   help for groups

lakectl auth groups create

그룹 만들기

lakectl auth groups create [flags]

Options

  -h, --help        help for create
      --id string   Group identifier

lakectl auth groups delete

그룹 삭제

lakectl auth groups delete [flags]

Options

  -h, --help        help for delete
      --id string   Group identifier

lakectl auth groups help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 groups help [명령 경로]처럼 입력하세요.

lakectl auth groups help [command] [flags]

Options

  -h, --help   help for help

lakectl auth groups list

그룹 목록

lakectl auth groups list [flags]

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth groups members

그룹 사용자 멤버십 관리

Options

  -h, --help   help for members

lakectl auth groups members add

그룹에 사용자 추가

lakectl auth groups members add [flags]

Options

  -h, --help          help for add
      --id string     Group identifier
      --user string   Username (email for password-based users, default: current user)

lakectl auth groups members help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 members help [명령 경로]처럼 입력하세요.

lakectl auth groups members help [command] [flags]

Options

  -h, --help   help for help

lakectl auth groups members list

그룹의 사용자 목록

lakectl auth groups members list [flags]

Options

      --id string       Group identifier
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth groups members remove

그룹에서 사용자 제거

lakectl auth groups members remove [flags]

Options

  -h, --help          help for remove
      --id string     Group identifier
      --user string   Username (email for password-based users, default: current user)

lakectl auth groups policies

그룹 정책 관리

Synopsis

그룹 정책을 관리해요. 대응하는 지원을 갖춘 외부 권한 서버가 필요해요.

Options

  -h, --help   help for policies

lakectl auth groups policies attach

그룹에 정책 연결

lakectl auth groups policies attach [flags]

Options

  -h, --help            help for attach
      --id string       User identifier
      --policy string   Policy identifier

lakectl auth groups policies detach

그룹에서 정책 분리

lakectl auth groups policies detach [flags]

Options

  -h, --help            help for detach
      --id string       User identifier
      --policy string   Policy identifier

lakectl auth groups policies help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 policies help [명령 경로]처럼 입력하세요.

lakectl auth groups policies help [command] [flags]

Options

  -h, --help   help for help

lakectl auth groups policies list

주어진 그룹의 정책 목록

lakectl auth groups policies list [flags]

Options

      --id string       Group identifier
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 auth help [명령 경로]처럼 입력하세요.

lakectl auth help [command] [flags]

Options

  -h, --help   help for help

lakectl auth policies

정책 관리

Options

  -h, --help   help for policies

lakectl auth policies create

정책 만들기

lakectl auth policies create [flags]

Options

  -h, --help                        help for create
      --id string                   Policy identifier
      --statement-document string   JSON statement document path (or "-" for stdin)

lakectl auth policies delete

정책 삭제

lakectl auth policies delete [flags]

Options

  -h, --help        help for delete
      --id string   Policy identifier

lakectl auth policies help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 policies help [명령 경로]처럼 입력하세요.

lakectl auth policies help [command] [flags]

Options

  -h, --help   help for help

lakectl auth policies list

정책 목록

lakectl auth policies list [flags]

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth policies show

정책 보기

lakectl auth policies show [flags]

Options

  -h, --help        help for show
      --id string   Policy identifier

lakectl auth tenants

테넌트(tenant) 관리

Options

  -h, --help   help for tenants

lakectl auth tenants create

테넌트 만들기

lakectl auth tenants create [flags]

Options

      --description string   Tenant description
  -h, --help                 help for create
      --name string          Tenant name

lakectl auth tenants delete

테넌트 삭제

lakectl auth tenants delete [flags]

Options

  -h, --help          help for delete
      --name string   Tenant name

lakectl auth tenants groups

테넌트 그룹 멤버십 관리

Options

  -h, --help   help for groups

lakectl auth tenants groups attach

테넌트에 그룹 연결

lakectl auth tenants groups attach [flags]

Options

      --group string   Group identifier
  -h, --help           help for attach
      --name string    Tenant name ('*' attaches to every tenant)

lakectl auth tenants groups detach

테넌트에서 그룹 분리

lakectl auth tenants groups detach [flags]

Options

      --group string   Group identifier
  -h, --help           help for detach
      --name string    Tenant name ('*' detaches the all-tenants attachment)

lakectl auth tenants groups help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 groups help [명령 경로]처럼 입력하세요.

lakectl auth tenants groups help [command] [flags]

Options

  -h, --help   help for help

lakectl auth tenants groups list

테넌트에 연결된 그룹 목록

lakectl auth tenants groups list [flags]

Options

      --name string     Tenant name ('*' lists the all-tenants attachments)
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth tenants help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 tenants help [명령 경로]처럼 입력하세요.

lakectl auth tenants help [command] [flags]

Options

  -h, --help   help for help

lakectl auth tenants list

테넌트 목록

lakectl auth tenants list [flags]

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth tenants show

테넌트 상세 정보 보기

lakectl auth tenants show [flags]

Options

  -h, --help          help for show
      --name string   Tenant name

lakectl auth tenants users

테넌트 사용자 멤버십 관리

Options

  -h, --help   help for users

lakectl auth tenants users attach

테넌트에 사용자 연결

lakectl auth tenants users attach [flags]

Options

  -h, --help          help for attach
      --name string   Tenant name ('*' attaches to every tenant)
      --user string   Username (email for password-based users)

lakectl auth tenants users detach

테넌트에서 사용자 분리

lakectl auth tenants users detach [flags]

Options

  -h, --help          help for detach
      --name string   Tenant name ('*' detaches the all-tenants attachment)
      --user string   Username (email for password-based users)

lakectl auth tenants users help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 users help [명령 경로]처럼 입력하세요.

lakectl auth tenants users help [command] [flags]

Options

  -h, --help   help for help

lakectl auth tenants users list

테넌트에 연결된 사용자 목록

lakectl auth tenants users list [flags]

Options

      --name string     Tenant name ('*' lists the all-tenants attachments)
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth users

사용자 관리

Options

  -h, --help   help for users

lakectl auth users aws-iam

lakeFS 사용자를 위한 AWS IAM Role 관리(External Principals API)

Options

  -h, --help   help for aws-iam

lakectl auth users aws-iam attach

lakeFS 사용자에 IAM 역할 연결

lakectl auth users aws-iam attach [flags]

Options

  -h, --help                  help for attach
      --id string             lakeFS Username (default: current user)
      --principal-id string   External principal ID (e.g., AWS IAM role ARN)

lakectl auth users aws-iam detach

lakeFS 사용자에서 IAM 역할 분리

lakectl auth users aws-iam detach [flags]

Options

  -h, --help                  help for detach
      --id string             lakeFS Username (default: current user)
      --principal-id string   External principal ID (e.g., AWS IAM role ARN)

lakectl auth users aws-iam help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 aws-iam help [명령 경로]처럼 입력하세요.

lakectl auth users aws-iam help [command] [flags]

Options

  -h, --help   help for help

lakectl auth users aws-iam list

lakeFS 사용자에 연결된 모든 IAM 역할 목록

lakectl auth users aws-iam list [flags]

Options

      --id string       lakeFS Username (default: current user)
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth users aws-iam lookup

IAM 역할 연결 조회

lakectl auth users aws-iam lookup [flags]

Options

  -h, --help                  help for lookup
      --principal-id string   External principal ID (e.g., AWS IAM role ARN)

lakectl auth users create

사용자 만들기

lakectl auth users create [flags]

Options

  -h, --help        help for create
      --id string   Username

lakectl auth users credentials

사용자 자격 증명 관리

Options

  -h, --help   help for credentials

lakectl auth users credentials create

사용자 자격 증명 생성

lakectl auth users credentials create [flags]

Options

  -h, --help        help for create
      --id string   Username (email for password-based users, default: current user)

lakectl auth users credentials delete

사용자 자격 증명 삭제

lakectl auth users credentials delete [flags]

Options

      --access-key-id string   Access key ID to delete
  -h, --help                   help for delete
      --id string              Username (email for password-based users, default: current user)

lakectl auth users credentials help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 credentials help [명령 경로]처럼 입력하세요.

lakectl auth users credentials help [command] [flags]

Options

  -h, --help   help for help

lakectl auth users credentials list

사용자 자격 증명 목록

lakectl auth users credentials list [flags]

Options

      --id string       Username (email for password-based users, default: current user)
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth users delete

사용자 삭제

lakectl auth users delete [flags]

Options

  -h, --help        help for delete
      --id string   Username (email for password-based users)

lakectl auth users groups

사용자 그룹 관리

Options

  -h, --help   help for groups

lakectl auth users groups help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 groups help [명령 경로]처럼 입력하세요.

lakectl auth users groups help [command] [flags]

Options

  -h, --help   help for help

lakectl auth users groups list

주어진 사용자의 그룹 목록

lakectl auth users groups list [flags]

Options

      --id string       Username (email for password-based users)
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth users help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 users help [명령 경로]처럼 입력하세요.

lakectl auth users help [command] [flags]

Options

  -h, --help   help for help

lakectl auth users list

사용자 목록

lakectl auth users list [flags]

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl auth users policies

사용자 정책 관리

Synopsis

사용자 정책을 관리해요. 대응하는 지원을 갖춘 외부 권한 서버가 필요해요.

Options

  -h, --help   help for policies

lakectl auth users policies attach

사용자에 정책 연결

lakectl auth users policies attach [flags]

Options

  -h, --help            help for attach
      --id string       Username (email for password-based users)
      --policy string   Policy identifier

lakectl auth users policies detach

사용자에서 정책 분리

lakectl auth users policies detach [flags]

Options

  -h, --help            help for detach
      --id string       Username (email for password-based users)
      --policy string   Policy identifier

lakectl auth users policies help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 policies help [명령 경로]처럼 입력하세요.

lakectl auth users policies help [command] [flags]

Options

  -h, --help   help for help

lakectl auth users policies list

주어진 사용자의 정책 목록

lakectl auth users policies list [flags]

Options

      --effective       List all distinct policies attached to the user, including by group memberships
      --id string       Username (email for password-based users)
      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl branch

저장소 안에서 브랜치 생성·관리

Synopsis

lakeFS 저장소 안에서 브랜치를 만들고, 지우고, 나열해요

Options

  -h, --help   help for branch

lakectl branch create

저장소에 새 브랜치 만들기

lakectl branch create <branch URI> -s <source ref URI> [flags]

Examples

lakectl branch create lakefs://example-repo/new-branch -s lakefs://example-repo/main

Options

  -h, --help            help for create
  -s, --source string   source branch uri

lakectl branch delete

저장소에서 브랜치와 그 미커밋 변경까지 삭제 (조심하세요)

lakectl branch delete <branch URI> [flags]

Examples

lakectl branch delete lakefs://my-repo/my-branch

Options

  -h, --help   help for delete
  -y, --yes    Automatically say yes to all confirmations

lakectl branch help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 branch help [명령 경로]처럼 입력하세요.

lakectl branch help [command] [flags]

Options

  -h, --help   help for help

lakectl branch list

저장소의 브랜치 목록

lakectl branch list <repository URI> [flags]

Examples

lakectl branch list lakefs://my-repo

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl branch reset

미커밋 변경 초기화 - 전체 또는 경로별

Synopsis

변경을 초기화(reset)해요. 방법은 세 가지예요:

  1. 모든 미커밋 변경 초기화 - reset lakefs://myrepo/main
  2. 특정 경로 아래의 미커밋 변경 초기화 - reset lakefs://myrepo/main --prefix path
  3. 특정 오브젝트의 미커밋 변경 초기화 - reset lakefs://myrepo/main --object path
lakectl branch reset <branch URI> [--prefix|--object] [flags]

Examples

lakectl branch reset lakefs://my-repo/my-branch

Options

  -h, --help            help for reset
      --object string   path to object to be reset
      --prefix string   prefix of the objects to be reset
  -y, --yes             Automatically say yes to all confirmations

lakectl branch revert

주어진 커밋의 효과를 되돌리는 새 커밋을 기록해요

Synopsis

커밋들은 왼쪽에서 오른쪽 순서로 되돌려져요

lakectl branch revert <branch URI> <commit ref to revert> [<more commits>...] [flags]

Examples

lakectl branch revert lakefs://example-repo/example-branch commitA
              Revert the changes done by commitA in example-branch
              branch revert lakefs://example-repo/example-branch HEAD~1 HEAD~2 HEAD~3
              Revert the changes done by the second last commit to the fourth last commit in example-branch

Options

      --allow-empty-commit   allow empty commit (revert without changes)
  -h, --help                 help for revert
  -m, --parent-number int    the parent number (starting from 1) of the mainline. The revert will reverse the change relative to the specified parent.
  -y, --yes                  Automatically say yes to all confirmations

lakectl branch show

브랜치의 최신 커밋 참조 보기

lakectl branch show <branch URI> [flags]

Examples

lakectl branch show lakefs://my-repo/my-branch

Options

  -h, --help   help for show

lakectl branch-protect

브랜치 보호 규칙 생성·관리

Synopsis

직접 변경을 막기 위해 브랜치 보호 규칙을 정의해요. 보호된 브랜치에 대한 변경은 다른 브랜치에서 머지하는 방법으로만 가능해요.

Options

  -h, --help   help for branch-protect

lakectl branch-protect add

브랜치 보호 규칙 추가

Synopsis

주어진 브랜치 이름 패턴에 브랜치 보호 규칙을 추가해요

lakectl branch-protect add <repository URI> <pattern> [flags]

Examples

lakectl branch-protect add lakefs://my-repo 'stable_*'

Options

  -h, --help   help for add

lakectl branch-protect delete

브랜치 보호 규칙 삭제

Synopsis

주어진 브랜치 이름 패턴의 브랜치 보호 규칙을 삭제해요

lakectl branch-protect delete <repository URI> <pattern> [flags]

Examples

lakectl branch-protect delete lakefs://my-repo stable_*

Options

  -h, --help   help for delete

lakectl branch-protect help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 branch-protect help [명령 경로]처럼 입력하세요.

lakectl branch-protect help [command] [flags]

Options

  -h, --help   help for help

lakectl branch-protect list

모든 브랜치 보호 규칙 목록

lakectl branch-protect list <repository URI> [flags]

Examples

lakectl branch-protect list lakefs://my-repo

Options

  -h, --help   help for list

lakectl branch-lifecycle

브랜치 라이프사이클 정책 관리

Synopsis

설정된 임계값(나이 또는 비활동 기간)을 넘으면 glob 패턴에 맞는 브랜치를 삭제하는 브랜치 라이프사이클 정책을 정의해요. 정책은 저장소 수준에 두며, 저장소의 기본 브랜치는 예외예요.

Options

  -h, --help   help for branch-lifecycle

lakectl branch-lifecycle clear

저장소에서 모든 브랜치 라이프사이클 정책 제거

Synopsis

저장소의 모든 브랜치 라이프사이클 정책을 삭제해요. 멱등(idempotent) 동작이라 정책이 하나도 없어도 성공해요.

lakectl branch-lifecycle clear <repository URI> [flags]

Examples

lakectl branch-lifecycle clear lakefs://my-repo

Options

  -h, --help   help for clear

lakectl branch-lifecycle get

저장소의 브랜치 라이프사이클 정책 보기

lakectl branch-lifecycle get <repository URI> [flags]

Examples

lakectl branch-lifecycle get lakefs://my-repo

Options

  -h, --help   help for get
  -p, --json   show as JSON

lakectl branch-lifecycle help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 branch-lifecycle help [명령 경로]처럼 입력하세요.

lakectl branch-lifecycle help [command] [flags]

Options

  -h, --help   help for help

lakectl branch-lifecycle set

YAML 또는 JSON 파일에서 브랜치 라이프사이클 정책 설정

Synopsis

저장소의 브랜치 라이프사이클 정책을 파일 내용으로 교체해요. 파일은 YAML로 파싱되며, JSON도 유효한 YAML이라 받아들여져요. 성공하면 서버가 정책 목록의 정규(canonical) 형태를 돌려주는데, id 없이 제출한 정책에 서버가 부여한 id도 포함돼요.

파일 예제: policies:

  • name_patterns: ["feature-", "wip-"] max_age: 7 max_inactivity_time: 3 description: "auto-cleanup of feature branches"
  • id: "temp-cleanup" name_patterns: ["temp-*"] max_inactivity_time: 30

max_age와 max_inactivity_time은 양의 정수일 수(일 단위)예요. 둘 중 하나는 반드시 필요하고, 둘 다 설정되면 두 임계값이 모두 넘어야 정책이 적용돼요(AND).

id는 선택 사항이에요: 재적용 시에도 안정적인 식별자를 유지하려면 제공하고, 생략하면 서버가 하나를 부여해요. id는 정책 목록 안에서 고유해야 하고, 최대 32자, 공백을 포함하면 안 돼요.

기본적으로 현재 ETag를 먼저 읽어 사전조건(precondition)으로 보내요. 정책이 원격에서 변경됐다면 업데이트는 HTTP 412로 실패해요. 사전조건 확인을 건너뛰려면 --force를 사용하세요.

lakectl branch-lifecycle set <repository URI> [flags]

Examples

lakectl branch-lifecycle set lakefs://my-repo -f policies.yaml

Options

  -f, --filename string   file containing the policies as YAML or JSON; '-' for stdin
      --force             skip ETag precondition check
  -h, --help              help for set

lakectl cherry-pick

기존 커밋이 도입한 변경 적용하기

Synopsis

주어진 커밋의 변경을 브랜치 끝(tip)에 적용해요. 변경은 새 커밋으로 추가돼요.

lakectl cherry-pick <commit URI> <branch> [flags]

Examples

lakectl cherry-pick lakefs://my-repo/600dc0ffee lakefs://my-repo/my-branch

Options

  -h, --help                help for cherry-pick
  -m, --parent-number int   the parent number (starting from 1) of the cherry-picked commit. The cherry-pick will apply the change relative to the specified parent.

lakectl commit

주어진 브랜치에 변경 커밋

lakectl commit <branch URI> [flags]

Options

      --allow-empty-commit    allow a commit with no changes
      --allow-empty-message   allow an empty commit message
  -h, --help                  help for commit
  -m, --message string        commit message
      --meta strings          key value pair in the form of key=value

lakectl completion

완성(completion) 스크립트 생성

Synopsis

완성을 로드하려면:

Bash:

$ source <(lakectl completion bash)

세션마다 완성을 로드하려면 한 번 실행하세요: Linux:

$ lakectl completion bash > /etc/bash_completion.d/lakectl

MacOS:

$ lakectl completion bash > /usr/local/etc/bash_completion.d/lakectl

Zsh:

셸 완성이 아직 활성화되어 있지 않다면 활성화해야 해요. 다음을 한 번 실행하세요:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

세션마다 완성을 로드하려면 한 번 실행하세요:

$ lakectl completion zsh > "${fpath[1]}/_lakectl"

이 설정이 적용되려면 새 셸을 시작해야 해요.

Fish:

$ lakectl completion fish | source

세션마다 완성을 로드하려면 한 번 실행하세요:

$ lakectl completion fish > ~/.config/fish/completions/lakectl.fish
lakectl completion <bash|zsh|fish>

Options

  -h, --help   help for completion

lakectl config

로컬 lakeFS 설정 생성/갱신

lakectl config [flags]

Options

  -h, --help   help for config

lakectl diff

두 커밋 사이의 변경, 또는 현재 미커밋 변경 보기

lakectl diff <ref URI> [ref URI] [flags]

Examples

    lakectl diff lakefs://example-repo/example-branch
    Show uncommitted changes in example-branch.

    lakectl diff lakefs://example-repo/main lakefs://example-repo/dev
    This shows the differences between master and dev starting at the last common commit.
    This is similar to the three-dot (...) syntax in git.
    Uncommitted changes are not shown.

    lakectl diff --two-way lakefs://example-repo/main lakefs://example-repo/dev
    Show changes between the tips of the main and dev branches.
    This is similar to the two-dot (..) syntax in git.
    Uncommitted changes are not shown.

    lakectl diff --two-way lakefs://example-repo/main lakefs://example-repo/dev$
    Show changes between the tip of the main and the dev branch, including uncommitted changes on dev.

    lakectl diff --prefix some/path lakefs://example-repo/main lakefs://example-repo/dev
    Show changes of objects prefixed with 'some/path' between the tips of the main and dev branches.

Options

  -h, --help            help for diff
      --prefix string   Show only changes in the given prefix.
      --two-way         Use two-way diff: show difference between the given refs, regardless of a common ancestor.

lakectl doctor

LakeFS 설정의 기본 진단 실행

lakectl doctor [flags]

Options

  -h, --help   help for doctor

lakectl fs

오브젝트 조회와 조작

Options

  -h, --help   help for fs

lakectl fs cat

오브젝트 내용을 stdout으로 덤프

lakectl fs cat <path URI> [flags]

Options

  -h, --help       help for cat
      --pre-sign   Use pre-signed URLs when downloading/uploading data (recommended) (default true)

lakectl fs download

주어진 저장소 경로에서 오브젝트 다운로드

lakectl fs download <path URI> [<destination path>] [flags]

Options

  -h, --help              help for download
      --no-progress       Disable progress bar animation for IO operations
  -p, --parallelism int   Max concurrent operations to perform (default 25)
      --part-size int     part size in bytes for multipart download (default 8388608)
      --pre-sign          Use pre-signed URLs when downloading/uploading data (recommended) (default true)
  -r, --recursive         recursively download all objects under path

lakectl fs help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 fs help [명령 경로]처럼 입력하세요.

lakectl fs help [command] [flags]

Options

  -h, --help   help for help

lakectl fs ls

주어진 트리 아래 항목 목록

lakectl fs ls <path URI> [flags]

Options

  -h, --help        help for ls
  -r, --recursive   list all objects under the specified path

lakectl fs presign

지정한 오브젝트를 읽기 위한 pre-signed URL 반환

lakectl fs presign <path URI> [flags]

Options

  -h, --help   help for presign

lakectl fs rm

오브젝트 삭제

lakectl fs rm <path URI> [flags]

Options

  -C, --concurrency int   max concurrent single delete operations to send to the lakeFS server (default 50)
  -h, --help              help for rm
  -r, --recursive         recursively delete all objects under the specified path

lakectl fs stat

오브젝트 메타데이터 보기

lakectl fs stat <path URI> [flags]

Options

  -h, --help       help for stat
      --pre-sign   Use pre-signed URLs when downloading/uploading data (recommended) (default true)

lakectl fs upload

로컬 파일을 지정한 URI로 업로드

lakectl fs upload <path URI> [flags]

Options

      --content-type string   MIME type of contents
  -h, --help                  help for upload
      --no-progress           Disable progress bar animation for IO operations
  -p, --parallelism int       Max concurrent operations to perform (default 25)
      --pre-sign              Use pre-signed URLs when downloading/uploading data (recommended) (default true)
  -r, --recursive             recursively copy all files under local source
  -s, --source string         local file to upload, or "-" for stdin

lakectl fs stage

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

저장소의 경로와 외부 오브젝트를 연결

Synopsis

저장소의 경로와 외부 오브젝트를 연결해서, 미커밋 변경을 만들어요. 오브젝트 위치는 반드시 저장소의 스토리지 네임스페이스 바깥이어야 해요

lakectl fs stage <path URI> [flags]

Options

      --checksum string       Object MD5 checksum as a hexadecimal string
      --content-type string   MIME type of contents
  -h, --help                  help for stage
      --location string       fully qualified storage location (i.e. "s3://bucket/path/to/object")
      --meta strings          key value pairs in the form of key=value
      --mtime int             Object modified time (Unix Epoch in seconds). Defaults to current time
      --size int              Object size in bytes

lakectl fs update-metadata

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

지정한 URI의 사용자 메타데이터 갱신

lakectl fs update-metadata <path URI> [flags]

Options

  -h, --help               help for update-metadata
      --metadata strings   Metadata to set, in the form key1=value1,key2=value2

lakectl gc

가비지 컬렉션 정책 관리

Options

  -h, --help   help for gc

lakectl gc delete-config

저장소의 가비지 컬렉션 정책 삭제

lakectl gc delete-config <repository URI> [flags]

Examples

lakectl gc delete-config lakefs://my-repo

Options

  -h, --help   help for delete-config

lakectl gc get-config

이 저장소의 가비지 컬렉션 정책 보기

lakectl gc get-config <repository URI> [flags]

Examples

lakectl gc get-config lakefs://my-repo

Options

  -h, --help   help for get-config
  -p, --json   get rules as JSON

lakectl gc help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 gc help [명령 경로]처럼 입력하세요.

lakectl gc help [command] [flags]

Options

  -h, --help   help for help

lakectl gc set-config

가비지 컬렉션 정책 JSON 설정

Synopsis

가비지 컬렉션 정책 JSON을 설정해요. 설정 파일 예제:

{
  "default_retention_days": 21,
  "branches": [
    {
      "branch_id": "main",
      "retention_days": 28
    },
    {
      "branch_id": "dev",
      "retention_days": 14
    }
  ]
}
lakectl gc set-config <repository URI> [flags]

Examples

lakectl gc set-config lakefs://my-repo -f config.json

Options

  -f, --filename string   file containing the GC policy as JSON
  -h, --help              help for set-config

lakectl gc check-async

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

(비동기) PrepareGarbageCollectionCommits의 상태 확인

lakectl gc check-async <repository URI> [flags]

Examples

lakectl gc check-async --id <ID> lakefs://my-repo

Options

  -h, --help        help for check-async
      --id string   ID returned from "gc prepare-async"

lakectl gc prepare-async

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

저장소에서 (비동기) PrepareGarbageCollectionCommits 실행

lakectl gc prepare-async <repository URI> [flags]

Examples

lakectl gc prepare-async lakefs://my-repo

Options

  -h, --help   help for prepare-async

lakectl help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 lakectl help [명령 경로]처럼 입력하세요.

lakectl help [command] [flags]

Options

  -h, --help   help for help

lakectl identity

신원(identity) 정보 보기

Synopsis

lakectl에 설정된 사용자의 정보를 보여줘요

lakectl identity [flags]

Examples

lakectl identity

Options

  -h, --help   help for identity

lakectl import

외부 소스에서 대상 브랜치로 데이터 임포트

lakectl import --from <object store URI> --to <lakeFS path URI> [flags]

Options

      --allow-empty-message   allow an empty commit message (default true)
      --from string           prefix to read from (e.g. "s3://bucket/sub/path/"). must not be in a storage namespace
  -h, --help                  help for import
  -m, --message string        commit message
      --meta strings          key value pair in the form of key=value
      --no-progress           switch off the progress output
      --to string             lakeFS path to load objects into (e.g. "lakefs://repo/branch/sub/path/")

lakectl local

로컬 디렉터와 lakeFS 경로 동기화

Options

  -h, --help   help for local

lakectl local checkout

로컬 디렉터를 원격 상태와 동기화해요.

lakectl local checkout [directory] [flags]

Options

      --all               Checkout given source branch or reference for all linked directories
  -h, --help              help for checkout
      --no-progress       Disable progress bar animation for IO operations
  -p, --parallelism int   Max concurrent operations to perform (default 25)
      --pre-sign          Use pre-signed URLs when downloading/uploading data (recommended) (default true)
  -r, --ref string        Checkout the given reference
  -y, --yes               Automatically say yes to all confirmations

lakectl local clone

lakeFS 저장소의 경로를 새 디렉터로 클론해요.

lakectl local clone <path URI> [directory] [flags]

Options

      --gitignore         Update .gitignore file when working in a git repository context (default true)
  -h, --help              help for clone
      --no-progress       Disable progress bar animation for IO operations
  -p, --parallelism int   Max concurrent operations to perform (default 25)
      --pre-sign          Use pre-signed URLs when downloading/uploading data (recommended) (default true)

lakectl local commit

로컬 디렉터의 변경을 그것이 추적하는 lakeFS 브랜치에 커밋해요.

lakectl local commit [directory] [flags]

Options

      --allow-empty-message   allow an empty commit message
      --force                 Commit changes even if remote branch includes uncommitted changes external to the synced path
  -h, --help                  help for commit
  -m, --message string        commit message
      --meta strings          key value pair in the form of key=value
      --no-progress           Disable progress bar animation for IO operations
  -p, --parallelism int       Max concurrent operations to perform (default 25)
      --pre-sign              Use pre-signed URLs when downloading/uploading data (recommended) (default true)
  -y, --yes                   Automatically say yes to all confirmations

lakectl local help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 local help [명령 경로]처럼 입력하세요.

lakectl local help [command] [flags]

Options

  -h, --help   help for help

lakectl local init

로컬 디렉터를 lakeFS 경로와 동기화되도록 지정해요.

lakectl local init <path URI> [directory] [flags]

Options

      --force       Overwrites if directory already linked to a lakeFS path
      --gitignore   Update .gitignore file when working in a git repository context (default true)
  -h, --help        help for init

lakectl local list

lakeFS와 동기화된 디렉터를 찾아 나열해요.

lakectl local list [directory] [flags]

Options

  -h, --help   help for list

lakectl local pull

lakeFS에서 최신 변경을 가져와요(fetch).

lakectl local pull [directory] [flags]

Options

      --force             Reset any uncommitted local change
  -h, --help              help for pull
      --no-progress       Disable progress bar animation for IO operations
  -p, --parallelism int   Max concurrent operations to perform (default 25)
      --pre-sign          Use pre-signed URLs when downloading/uploading data (recommended) (default true)

lakectl local status

디렉터와 그것이 추적하는 원격 위치에 대한 수정 사항(원격과 로컬 모두)을 보여줘요

lakectl local status [directory] [flags]

Options

  -h, --help    help for status
  -l, --local   Don't compare against remote changes

lakectl log

커밋 로그 보기

Synopsis

주어진 참조의 커밋 로그를 보여줘요

lakectl log <ref URI> [flags]

Examples

lakectl log --dot lakefs://example-repository/main | dot -Tsvg > graph.svg

Options

      --after string         show results after this value (used for pagination)
      --amount int           number of results to return. By default, all results are returned
      --dot                  return results in a dotgraph format
      --first-parent         follow only the first parent commit upon seeing a merge commit
  -h, --help                 help for log
      --limit                limit result just to amount. By default, returns whether more items are available.
      --no-merges            skip merge commits
      --objects strings      show results that contains changes to at least one path in that list of objects. Use comma separator to pass all objects together
      --prefixes strings     show results that contains changes to at least one path in that list of prefixes. Use comma separator to pass all prefixes together
      --show-meta-range-id   also show meta range ID
      --since string         show results since this date-time (RFC3339 format)
      --stop-at string       a Ref to stop at (included in results)

lakectl login

웹 브라우저로 lakeFS에 로그인해요

Synopsis

웹 브라우저를 사용해 lakeFS에 연결해요.

lakectl login [flags]

Examples

lakectl login

Options

  -h, --help   help for login

lakectl merge

소스 브랜치의 변경을 대상 브랜치로 머지 & 커밋

Synopsis

소스 브랜치의 변경을 대상 브랜치로 머지 & 커밋해요

lakectl merge <source ref> <destination ref> [flags]

Options

      --allow-empty           Allow merge when the branches have the same content
      --allow-empty-message   allow an empty commit message (default true)
      --force                 Allow merge into a read-only branch or into a branch with the same content
  -h, --help                  help for merge
  -m, --message string        commit message
      --meta strings          key value pair in the form of key=value
      --squash                Squash all changes from source into a single commit on destination
      --strategy string       In case of a merge conflict, this option will force the merge process to automatically favor changes from the dest branch ("dest-wins") or from the source branch("source-wins"). In case no selection is made, the merge process will fail in case of a conflict

lakectl object-lifecycle

오브젝트 라이프사이클 규칙 관리

Synopsis

설정된 보존 기간보다 나이가 많아지면 대상 브랜치의 커밋된 오브젝트를 만료시키는 오브젝트 라이프사이클 규칙을 정의해요. 규칙은 저장소 수준에 둬요.

Options

  -h, --help   help for object-lifecycle

lakectl object-lifecycle clear

저장소에서 모든 오브젝트 라이프사이클 규칙 제거

Synopsis

저장소의 모든 오브젝트 라이프사이클 규칙을 삭제해요. 멱등(idempotent) 동작이라 규칙이 하나도 없어도 성공해요.

lakectl object-lifecycle clear <repository URI> [flags]

Examples

lakectl object-lifecycle clear lakefs://my-repo

Options

  -h, --help   help for clear

lakectl object-lifecycle get

저장소의 오브젝트 라이프사이클 규칙 보기

lakectl object-lifecycle get <repository URI> [flags]

Examples

lakectl object-lifecycle get lakefs://my-repo

Options

  -h, --help   help for get
  -p, --json   show as JSON

lakectl object-lifecycle help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 object-lifecycle help [명령 경로]처럼 입력하세요.

lakectl object-lifecycle help [command] [flags]

Options

  -h, --help   help for help

lakectl object-lifecycle set

YAML 또는 JSON 파일에서 오브젝트 라이프사이클 규칙 설정

Synopsis

저장소의 오브젝트 라이프사이클 규칙을 파일 내용으로 교체해요. 파일은 YAML로 파싱되며, JSON도 유효한 YAML이라 받아들여져요.

파일 예제: rules:

  • id: "raw-staging-expiry" prefix: "raw/" branches: ["main"] expire_after_days: 90 description: "Expire raw staging objects"
  • id: "max-retention" prefix: "" branches: ["main", "staging"] expire_after_days: 1095

id는 규칙 세트 안에서 고유해야 하고, 소문자 영숫자와 하이픈만 포함해야 해요. prefix는 문자 그대로의 키 프리픽스로, 비워 두거나(모든 오브젝트) "/"로 끝나야 해요. expire_after_days는 양의 일수예요. 규칙 세트는 전체로 검증돼요: 최대 1000개 규칙, 최대 20개의 서로 다른 대상 브랜치.

lakectl object-lifecycle set <repository URI> [flags]

Examples

lakectl object-lifecycle set lakefs://my-repo -f policies.yaml

Options

  -f, --filename string   file containing the rules as YAML or JSON; '-' for stdin
  -h, --help              help for set

lakectl plugin

lakectl 플러그인 관리

Synopsis

lakectl 플러그인을 관리하는 유틸리티를 제공해요.

플러그인은 lakectl의 기능을 확장하는 독립 실행형 실행 파일이에요. lakectl은 PATH에서 "lakectl-" 접두사로 이름 붙은 실행 파일을 찾아 플러그인을 발견해요.

예를 들어 "lakectl-myfeature"라는 실행 파일은 "lakectl myfeature [args...]"로 호출할 수 있어요.

플러그인 이름 짓기:

  • 실행 파일은 반드시 "lakectl-"로 시작해야 해요.
  • "lakectl-" 뒷부분이 사용자가 입력하는 명령 이름이 돼요. (예: "lakectl-foo" -> "lakectl foo")
  • 플러그인 이름은 명령에서 그대로 사용돼요. (예: "lakectl-foo-bar" -> "lakectl foo-bar")

설치:

  • "lakectl-..." 실행 파일(어떤 실행 파일이든 가능, 예: Python 애플리케이션)을 PATH에 나열된 디렉터에 두세요.
  • 파일에 실행 권한이 있는지 확인하세요.

실행:

  • "lakectl some-plugin arg1 --flag"를 실행하면 lakectl이 PATH에서 "lakectl-some-plugin"을 찾아요.
  • 찾아지고 실행 가능하면 그 플러그인을 실행하며 "arg1 --flag"를 인자로 넘겨요.
  • 플러그인은 lakectl의 환경 변수를 상속받아요.
  • 플러그인의 표준 출력, 표준 에러, 종료 코드는 그대로 전달돼요.
  • 내장 lakectl 명령은 항상 플러그인보다 우선해요.

발견된 모든 플러그인과 경고를 보려면 "lakectl plugin list"를 사용하세요.

Options

  -h, --help   help for plugin

lakectl plugin help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 plugin help [명령 경로]처럼 입력하세요.

lakectl plugin help [command] [flags]

Options

  -h, --help   help for help

lakectl plugin list

사용 가능한 lakectl 플러그인 목록

Synopsis

PATH에서 "lakectl-*"라는 이름의 실행 파일을 스캔하고 발견된 플러그인을 나열해요.

lakectl plugin list [flags]

Options

  -h, --help   help for list

lakectl repo

저장소 관리와 탐색

Options

  -h, --help   help for repo

lakectl repo create

새 저장소 만들기

lakectl repo create <repository URI> <storage namespace> [flags]

Examples

lakectl repo create lakefs://my-repo s3://my-bucket

Options

  -d, --default-branch string   the default branch of this repository (default "main")
  -h, --help                    help for create
      --sample-data             create sample data in the repository
      --storage-id string       id of the storage to use; applies only when the server is configured with blockstores

lakectl repo delete

기존 저장소 삭제

lakectl repo delete <repository URI> [flags]

Examples

lakectl repo delete lakefs://my-repo

Options

  -h, --help   help for delete
  -y, --yes    Automatically say yes to all confirmations

lakectl repo help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 repo help [명령 경로]처럼 입력하세요.

lakectl repo help [command] [flags]

Options

  -h, --help   help for help

lakectl repo list

저장소 목록

lakectl repo list [flags]

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl repo create-bare

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

초기 브랜치나 커밋 없는 새 저장소 만들기

lakectl repo create-bare <repository URI> <storage namespace> [flags]

Examples

lakectl repo create-bare lakefs://my-repo s3://my-bucket

Options

  -d, --default-branch string   the default branch name of this repository (will not be created) (default "main")
  -h, --help                    help for create-bare
      --storage-id string       id of the storage to use; applies only when the server is configured with blockstores

lakectl show

엔티티에 대한 상세 정보 보기

Options

  -h, --help   help for show

lakectl show commit

커밋에 대한 상세 정보 보기

lakectl show commit <commit URI> [flags]

Options

  -h, --help                 help for commit
      --show-meta-range-id   show meta range ID

lakectl show help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 show help [명령 경로]처럼 입력하세요.

lakectl show help [command] [flags]

Options

  -h, --help   help for help

lakectl skill

lakectl을 AI 에이전트가 쓸 수 있게 SKILL.md 생성

Synopsis

lakectl 전체 명령 레퍼런스를 AI 에이전트가 소비하기 좋은 형태로 담은 SKILL.md 파일을 생성해요. 출력에는 모든 명령(숨겨진 내부 명령 포함)과 플래그, 사용법, 예제가 YAML 프론트매터와 함께 깔끔한 markdown으로 들어가요.

lakectl skill [flags]

Options

  -h, --help   help for skill

lakectl tag

저장소 안에서 태그 생성·관리

Synopsis

lakeFS 저장소 안에서 태그를 만들고, 지우고, 나열해요

Options

  -h, --help   help for tag

lakectl tag create

저장소에 새 태그 만들기

lakectl tag create <tag URI> <commit URI> [flags]

Examples

lakectl tag create lakefs://example-repo/example-tag lakefs://example-repo/2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917

Options

  -f, --force   override the tag if it exists
  -h, --help    help for create

lakectl tag delete

저장소에서 태그 삭제

lakectl tag delete <tag URI> [flags]

Options

  -h, --help   help for delete
  -y, --yes    Automatically say yes to all confirmations

lakectl tag help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 tag help [명령 경로]처럼 입력하세요.

lakectl tag help [command] [flags]

Options

  -h, --help   help for help

lakectl tag list

저장소의 태그 목록

lakectl tag list <repository URI> [flags]

Examples

lakectl tag list lakefs://my-repo

Options

      --amount int      how many results to return (default 100)
      --after string    show results after this value (used for pagination)
      --prefix string   filter results by prefix (used for pagination)
  -h, --help            help for list

lakectl tag show

태그의 커밋 참조 보기

lakectl tag show <tag URI> [flags]

Options

  -h, --help   help for show

문서화되지 않은 명령

Warning

이 명령들은 plumbing 명령이며 내부 전용이에요. 정말로 무엇을 하는지 확실히 아는 경우나 lakeFS 지원 팀과 접촉한 적이 있는 경우가 아니라면 사용을 피하세요.

lakectl abuse

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

동작 중인 lakeFS 인스턴스를 의도적으로 부하를 주듯이 사용해요(abuse). 자세한 내용은 하위 명령을 보세요.

Options

  -h, --help   help for abuse

lakectl abuse commit

소스 브랜치에 반복해서 커밋해요

lakectl abuse commit <branch URI> [flags]

Options

      --amount int     amount of commits to do (default 100)
      --gap duration   duration to wait between commits (default 2s)
  -h, --help           help for commit

lakectl abuse create-branches

아주 빠르게 많은 브랜치를 만들어요.

lakectl abuse create-branches <source ref URI> [flags]

Options

      --amount int             amount of things to do (default 1000000)
      --branch-prefix string   prefix to create branches under (default "abuse-")
      --clean-only             only clean up past runs
  -h, --help                   help for create-branches
      --parallelism int        amount of things to do in parallel (default 100)

lakectl abuse help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 abuse help [명령 경로]처럼 입력하세요.

lakectl abuse help [command] [flags]

Options

  -h, --help   help for help

같은 오브젝트를 병렬로 연결해요.

lakectl abuse link-same-object <branch URI> [flags]

Options

      --amount int        amount of link object to do (default 1000000)
  -h, --help              help for link-same-object
      --key string        key used for the test (default "linked-object")
      --parallelism int   amount of link object to do in parallel (default 100)

lakectl abuse list

소스 ref에서 목록을 조회해요

lakectl abuse list <source ref URI> [flags]

Options

      --amount int        amount of lists to do (default 1000000)
  -h, --help              help for list
      --parallelism int   amount of lists to do in parallel (default 100)
      --prefix string     prefix to list under (default "abuse/")

lakectl abuse merge

충돌하지 않는 오브젝트를 소스 브랜치로 병렬 머지해요

lakectl abuse merge <branch URI> [flags]

Options

      --amount int        amount of merges to perform (default 1000)
  -h, --help              help for merge
      --parallelism int   number of merges to perform in parallel (default 100)

lakectl abuse random-delete

파일에서 키를 읽어 그 키들로 소스 ref에 무작위 삭제를 생성해요.

lakectl abuse random-delete <source ref URI> [flags]

Options

      --amount int         amount of reads to do (default 1000000)
      --from-file string   read keys from this file ("-" for stdin)
  -h, --help               help for random-delete
      --parallelism int    amount of reads to do in parallel (default 100)

lakectl abuse random-read

파일에서 키를 읽어 그 키들로 소스 ref에 무작위 읽기를 생성해요.

lakectl abuse random-read <source ref URI> [flags]

Options

      --amount int         amount of reads to do (default 1000000)
      --from-file string   read keys from this file ("-" for stdin)
  -h, --help               help for random-read
      --parallelism int    amount of reads to do in parallel (default 100)

lakectl abuse random-write

소스 브랜치에 무작위 쓰기를 생성해요

lakectl abuse random-write <branch URI> [flags]

Options

      --amount int        amount of writes to do (default 1000000)
  -h, --help              help for random-write
      --parallelism int   amount of writes to do in parallel (default 100)
      --prefix string     prefix to create paths under (default "abuse/")

lakectl bisect

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

버그를 도입한 커밋을 찾는 이진 탐색

Options

  -h, --help   help for bisect

lakectl bisect bad

버그가 있다고 알려진 'bad' 커밋을 지정해요

lakectl bisect bad [flags]

Options

  -h, --help   help for bad

lakectl bisect good

버그가 도입되기 전이라고 알려진 커밋을 'good' 커밋으로 지정해요

lakectl bisect good [flags]

Options

  -h, --help   help for good

lakectl bisect help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 bisect help [명령 경로]처럼 입력하세요.

lakectl bisect help [command] [flags]

Options

  -h, --help   help for help

lakectl bisect log

현재 bisect 상태를 출력해요

lakectl bisect log [flags]

Options

  -h, --help   help for log

lakectl bisect reset

bisect 상태를 정리해요

lakectl bisect reset [flags]

Options

  -h, --help   help for reset

lakectl bisect run

명령의 종료 코드를 기준으로 bisect를 진행해요

lakectl bisect run <command> [flags]

Options

  -h, --help   help for run

lakectl bisect start

bisect 세션 시작

lakectl bisect start <bad ref URI> <good ref URI> [flags]

Options

  -h, --help   help for start

lakectl bisect view

현재 bisect 커밋들

lakectl bisect view [flags]

Options

  -h, --help   help for view

lakectl cat-hook-output

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

actions 훅 출력 내용 보기

lakectl cat-hook-output <repository URI> <run_id> <hook_id> [flags]

Examples

lakectl cat-hook-output lakefs://my-repo 20230719152411arS0z6I my_hook_name

Options

  -h, --help   help for cat-hook-output

lakectl cat-sst

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

lakeFS .sst 파일 탐색

lakectl cat-sst <sst-file> [flags]

Options

      --amount int    how many records to return, or -1 for all records (default -1)
  -f, --file string   path to an sstable file, or "-" for stdin
  -h, --help          help for cat-sst

lakectl docs

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

lakectl docs [outfile] [flags]

Options

  -h, --help   help for docs

lakectl find-merge-base

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

머지 작업의 기준이 되는 커밋들을 찾아요

lakectl find-merge-base <source ref URI> <destination ref URI> [flags]

Options

  -h, --help   help for find-merge-base

lakectl refs-dump

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

refs(브랜치, 커밋, 태그)를 기반 오브젝트 스토어로 덤프해요

lakectl refs-dump <repository URI> [flags]

Options

  -h, --help                     help for refs-dump
  -o, --output string            output filename (default stdout)
      --poll-interval duration   poll status check interval (default 3s)
      --timeout duration         timeout for polling status checks (default 1h0m0s)

lakectl refs-restore

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

기반 오브젝트 스토어에서 refs(브랜치, 커밋, 태그)를 bare 저장소로 복원해요

Synopsis

기반 오브젝트 스토어에서 refs(브랜치, 커밋, 태그)를 bare 저장소로 복원해요.

이 명령은 bare 저장소(즉 'lakectl repo create-bare'로 만든 저장소)에서 실행할 것으로 기대돼요. bare 저장소가 기대되므로, 일시적 실패가 발생하면 저장소를 지우고 bare로 다시 만든 뒤 재시도하세요.

lakectl refs-restore <repository URI> [flags]

Examples

aws s3 cp s3://bucket/_lakefs/refs_manifest.json - | lakectl refs-restore lakefs://my-bare-repository --manifest -

Options

  -h, --help                     help for refs-restore
      --manifest refs-dump       path to a refs manifest json file (as generated by refs-dump). Alternatively, use "-" to read from stdin
      --poll-interval duration   poll status check interval (default 3s)
      --timeout duration         timeout for polling status checks (default 1h0m0s)

lakectl usage

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

lakeFS의 사용량(usage) 리포트

Options

  -h, --help   help for usage

lakectl usage help

모든 명령에 대한 도움말

Synopsis

Help는 애플리케이션의 어떤 명령에 대해서도 도움말을 제공해요. 전체 내용은 usage help [명령 경로]처럼 입력하세요.

lakectl usage help [command] [flags]

Options

  -h, --help   help for help

lakectl usage summary

Warning

lakeFS plumbing 명령이에요. 정말로 무엇을 하는지 확실히 아는 경우가 아니면 사용하지 마세요.

lakeFS의 요약(summary) 리포트

lakectl usage summary [flags]

Options

  -h, --help   help for summary

더 알아보기 (Learn more)

공식 문서의 자세한 내용은 https://docs.lakefs.io/reference/cli/enterprise/에서 확인하실 수 있어요.