github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/docs/reference/cli.md (about) 1 --- 2 title: lakectl (lakeFS command-line tool) 3 description: lakeFS comes with its own native CLI client. Here you can see the complete command reference. 4 parent: Reference 5 redirect_from: 6 - /reference/commands.html 7 - /quickstart/lakefs_cli.html 8 --- 9 10 {% comment %} 11 This file (cli.md) is automagically generated from the Go code files under cmd/lakectl. 12 Any changes made directly to the Markdown file will be overwritten, and should instead be made to the 13 relevant Go files. 14 {% endcomment %} 15 16 # lakectl (lakeFS command-line tool) 17 {:.no_toc} 18 19 {% include toc.html %} 20 21 ## Installing lakectl locally 22 23 `lakectl` is available for Linux, macOS, and Windows. You can also [run it using Docker](#running-lakectl-from-docker). 24 25 [Download lakectl](https://github.com/treeverse/lakeFS/releases){: .btn .btn-green target="_blank"} 26 27 Or using [Homebrew](https://brew.sh/) for Linux/macOS: 28 29 ```sh 30 brew tap treeverse/lakefs 31 brew install lakefs 32 ``` 33 34 ### Configuring credentials and API endpoint 35 36 Once you've installed the lakectl command, run: 37 38 ```bash 39 lakectl config 40 # output: 41 # Config file /home/janedoe/.lakectl.yaml will be used 42 # Access key ID: AKIAIOSFODNN7EXAMPLE 43 # Secret access key: **************************************** 44 # Server endpoint URL: http://localhost:8000 45 ``` 46 47 This will setup a `$HOME/.lakectl.yaml` file with the credentials and API endpoint you've supplied. 48 When setting up a new installation and creating initial credentials (see [Quickstart]({{ site.baseurl }}/quickstart/index.md)), the UI 49 will provide a link to download a preconfigured configuration file for you. 50 51 `lakectl` configuration items can each be controlled by an environment variable. The variable name will have a prefix of 52 *LAKECTL_*, followed by the name of the configuration, replacing every '.' with a '_'. Example: `LAKECTL_SERVER_ENDPOINT_URL` 53 controls `server.endpoint_url`. 54 55 ## Running lakectl from Docker 56 57 If you'd rather run `lakectl` from a Docker container you can do so by passing configuration elements as environment variables. 58 Here is an example: 59 60 ```bash 61 docker run --rm --pull always \ 62 -e LAKECTL_CREDENTIALS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \ 63 -e LAKECTL_CREDENTIALS_SECRET_ACCESS_KEY=xxxxx 64 -e LAKECTL_SERVER_ENDPOINT_URL=https://host.us-east-2.lakefscloud.io/ \ 65 --entrypoint lakectl treeverse/lakefs \ 66 repo list 67 ``` 68 69 _Bear in mind that if you are running lakeFS itself locally you will need to account for this in your networking configuration of 70 the Docker container. That is to say, `localhost` to a Docker container is itself, not the host machine on which it is running._ 71 72 ## Command Reference 73 ### lakectl 74 75 A cli tool to explore manage and work with lakeFS 76 77 #### Synopsis 78 {:.no_toc} 79 80 lakectl is a CLI tool allowing exploration and manipulation of a lakeFS environment 81 82 ``` 83 lakectl [flags] 84 ``` 85 86 #### Options 87 {:.no_toc} 88 89 ``` 90 --base-uri string base URI used for lakeFS address parse 91 -c, --config string config file (default is $HOME/.lakectl.yaml) 92 -h, --help help for lakectl 93 --log-format string set logging output format 94 --log-level string set logging level (default "none") 95 --log-output strings set logging output(s) 96 --no-color don't use fancy output colors (default value can be set by NO_COLOR environment variable) 97 --verbose run in verbose mode 98 -v, --version version for lakectl 99 ``` 100 101 **note:** The `base-uri` option can be controlled with the `LAKECTL_BASE_URI` environment variable. 102 {: .note .note-warning } 103 104 #### Example usage 105 {:.no_toc} 106 107 ```shell 108 $ export LAKECTL_BASE_URI="lakefs://my-repo/my-branch" 109 # Once set, use relative lakefs uri's: 110 $ lakectl fs ls /path 111 ``` 112 113 ### lakectl abuse 114 115 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 116 {: .note .note-warning } 117 118 Abuse a running lakeFS instance. See sub commands for more info. 119 120 #### Options 121 {:.no_toc} 122 123 ``` 124 -h, --help help for abuse 125 ``` 126 127 128 129 ### lakectl abuse commit 130 131 Commits to the source branch repeatedly 132 133 ``` 134 lakectl abuse commit <branch URI> [flags] 135 ``` 136 137 #### Options 138 {:.no_toc} 139 140 ``` 141 --amount int amount of commits to do (default 100) 142 --gap duration duration to wait between commits (default 2s) 143 -h, --help help for commit 144 ``` 145 146 147 148 ### lakectl abuse create-branches 149 150 Create a lot of branches very quickly. 151 152 ``` 153 lakectl abuse create-branches <source ref URI> [flags] 154 ``` 155 156 #### Options 157 {:.no_toc} 158 159 ``` 160 --amount int amount of things to do (default 1000000) 161 --branch-prefix string prefix to create branches under (default "abuse-") 162 --clean-only only clean up past runs 163 -h, --help help for create-branches 164 --parallelism int amount of things to do in parallel (default 100) 165 ``` 166 167 168 169 ### lakectl abuse help 170 171 Help about any command 172 173 #### Synopsis 174 {:.no_toc} 175 176 Help provides help for any command in the application. 177 Simply type abuse help [path to command] for full details. 178 179 ``` 180 lakectl abuse help [command] [flags] 181 ``` 182 183 #### Options 184 {:.no_toc} 185 186 ``` 187 -h, --help help for help 188 ``` 189 190 191 192 ### lakectl abuse link-same-object 193 194 Link the same object in parallel. 195 196 ``` 197 lakectl abuse link-same-object <branch URI> [flags] 198 ``` 199 200 #### Options 201 {:.no_toc} 202 203 ``` 204 --amount int amount of link object to do (default 1000000) 205 -h, --help help for link-same-object 206 --key string key used for the test (default "linked-object") 207 --parallelism int amount of link object to do in parallel (default 100) 208 ``` 209 210 211 212 ### lakectl abuse list 213 214 List from the source ref 215 216 ``` 217 lakectl abuse list <source ref URI> [flags] 218 ``` 219 220 #### Options 221 {:.no_toc} 222 223 ``` 224 --amount int amount of lists to do (default 1000000) 225 -h, --help help for list 226 --parallelism int amount of lists to do in parallel (default 100) 227 --prefix string prefix to list under (default "abuse/") 228 ``` 229 230 231 232 ### lakectl abuse random-delete 233 234 Delete keys from a file and generate random delete from the source ref for those keys. 235 236 ``` 237 lakectl abuse random-delete <source ref URI> [flags] 238 ``` 239 240 #### Options 241 {:.no_toc} 242 243 ``` 244 --amount int amount of reads to do (default 1000000) 245 --from-file string read keys from this file ("-" for stdin) 246 -h, --help help for random-delete 247 --parallelism int amount of reads to do in parallel (default 100) 248 ``` 249 250 251 252 ### lakectl abuse random-read 253 254 Read keys from a file and generate random reads from the source ref for those keys. 255 256 ``` 257 lakectl abuse random-read <source ref URI> [flags] 258 ``` 259 260 #### Options 261 {:.no_toc} 262 263 ``` 264 --amount int amount of reads to do (default 1000000) 265 --from-file string read keys from this file ("-" for stdin) 266 -h, --help help for random-read 267 --parallelism int amount of reads to do in parallel (default 100) 268 ``` 269 270 271 272 ### lakectl abuse random-write 273 274 Generate random writes to the source branch 275 276 ``` 277 lakectl abuse random-write <branch URI> [flags] 278 ``` 279 280 #### Options 281 {:.no_toc} 282 283 ``` 284 --amount int amount of writes to do (default 1000000) 285 -h, --help help for random-write 286 --parallelism int amount of writes to do in parallel (default 100) 287 --prefix string prefix to create paths under (default "abuse/") 288 ``` 289 290 291 292 ### lakectl actions 293 294 Manage Actions commands 295 296 #### Options 297 {:.no_toc} 298 299 ``` 300 -h, --help help for actions 301 ``` 302 303 304 305 ### lakectl actions help 306 307 Help about any command 308 309 #### Synopsis 310 {:.no_toc} 311 312 Help provides help for any command in the application. 313 Simply type actions help [path to command] for full details. 314 315 ``` 316 lakectl actions help [command] [flags] 317 ``` 318 319 #### Options 320 {:.no_toc} 321 322 ``` 323 -h, --help help for help 324 ``` 325 326 327 328 ### lakectl actions runs 329 330 Explore runs information 331 332 #### Options 333 {:.no_toc} 334 335 ``` 336 -h, --help help for runs 337 ``` 338 339 340 341 ### lakectl actions runs describe 342 343 Describe run results 344 345 #### Synopsis 346 {:.no_toc} 347 348 Show information about the run and all the hooks that were executed as part of the run 349 350 ``` 351 lakectl actions runs describe <repository URI> <run_id> [flags] 352 ``` 353 354 #### Examples 355 {:.no_toc} 356 357 ``` 358 lakectl actions runs describe lakefs://my-repo 20230719152411arS0z6I 359 ``` 360 361 #### Options 362 {:.no_toc} 363 364 ``` 365 --after string show results after this value (used for pagination) 366 --amount int number of results to return. By default, all results are returned. 367 -h, --help help for describe 368 ``` 369 370 371 372 ### lakectl actions runs help 373 374 Help about any command 375 376 #### Synopsis 377 {:.no_toc} 378 379 Help provides help for any command in the application. 380 Simply type runs help [path to command] for full details. 381 382 ``` 383 lakectl actions runs help [command] [flags] 384 ``` 385 386 #### Options 387 {:.no_toc} 388 389 ``` 390 -h, --help help for help 391 ``` 392 393 394 395 ### lakectl actions runs list 396 397 List runs 398 399 #### Synopsis 400 {:.no_toc} 401 402 List all runs on a repository optional filter by branch or commit 403 404 ``` 405 lakectl actions runs list <repository URI> [--branch <branch>] [--commit <commit_id>] [flags] 406 ``` 407 408 #### Examples 409 {:.no_toc} 410 411 ``` 412 lakectl actions runs list lakefs://my-repo --branch my-branch --commit 600dc0ffee 413 ``` 414 415 #### Options 416 {:.no_toc} 417 418 ``` 419 --after string show results after this value (used for pagination) 420 --amount int number of results to return (default 100) 421 --branch string show results for specific branch 422 --commit string show results for specific commit ID 423 -h, --help help for list 424 ``` 425 426 427 428 ### lakectl actions validate 429 430 Validate action file 431 432 #### Synopsis 433 {:.no_toc} 434 435 Tries to parse the input action file as lakeFS action file 436 437 ``` 438 lakectl actions validate [flags] 439 ``` 440 441 #### Examples 442 {:.no_toc} 443 444 ``` 445 lakectl actions validate path/to/my/file 446 ``` 447 448 #### Options 449 {:.no_toc} 450 451 ``` 452 -h, --help help for validate 453 ``` 454 455 456 457 ### lakectl annotate 458 459 List entries under a given path, annotating each with the latest modifying commit 460 461 ``` 462 lakectl annotate <path URI> [flags] 463 ``` 464 465 #### Options 466 {:.no_toc} 467 468 ``` 469 --first-parent follow only the first parent commit upon seeing a merge commit 470 -h, --help help for annotate 471 -r, --recursive recursively annotate all entries under a given path or prefix 472 ``` 473 474 475 476 ### lakectl auth 477 478 Manage authentication and authorization 479 480 #### Synopsis 481 {:.no_toc} 482 483 manage authentication and authorization including users, groups and ACLs 484 485 #### Options 486 {:.no_toc} 487 488 ``` 489 -h, --help help for auth 490 ``` 491 492 493 494 ### lakectl auth groups 495 496 Manage groups 497 498 #### Options 499 {:.no_toc} 500 501 ``` 502 -h, --help help for groups 503 ``` 504 505 506 507 ### lakectl auth groups acl 508 509 Manage ACLs 510 511 #### Synopsis 512 {:.no_toc} 513 514 manage ACLs of groups 515 516 #### Options 517 {:.no_toc} 518 519 ``` 520 -h, --help help for acl 521 ``` 522 523 524 525 ### lakectl auth groups acl get 526 527 Get ACL of group 528 529 ``` 530 lakectl auth groups acl get [flags] 531 ``` 532 533 #### Options 534 {:.no_toc} 535 536 ``` 537 -h, --help help for get 538 --id string Group identifier 539 ``` 540 541 542 543 ### lakectl auth groups acl help 544 545 Help about any command 546 547 #### Synopsis 548 {:.no_toc} 549 550 Help provides help for any command in the application. 551 Simply type acl help [path to command] for full details. 552 553 ``` 554 lakectl auth groups acl help [command] [flags] 555 ``` 556 557 #### Options 558 {:.no_toc} 559 560 ``` 561 -h, --help help for help 562 ``` 563 564 565 566 ### lakectl auth groups acl set 567 568 Set ACL of group 569 570 #### Synopsis 571 {:.no_toc} 572 573 Set ACL of group. permission will be attached to all repositories. 574 575 ``` 576 lakectl auth groups acl set [flags] 577 ``` 578 579 #### Options 580 {:.no_toc} 581 582 ``` 583 -h, --help help for set 584 --id string Group identifier 585 --permission string Permission, typically one of "Read", "Write", "Super" or "Admin" 586 ``` 587 588 589 590 ### lakectl auth groups create 591 592 Create a group 593 594 ``` 595 lakectl auth groups create [flags] 596 ``` 597 598 #### Options 599 {:.no_toc} 600 601 ``` 602 -h, --help help for create 603 --id string Group identifier 604 ``` 605 606 607 608 ### lakectl auth groups delete 609 610 Delete a group 611 612 ``` 613 lakectl auth groups delete [flags] 614 ``` 615 616 #### Options 617 {:.no_toc} 618 619 ``` 620 -h, --help help for delete 621 --id string Group identifier 622 ``` 623 624 625 626 ### lakectl auth groups help 627 628 Help about any command 629 630 #### Synopsis 631 {:.no_toc} 632 633 Help provides help for any command in the application. 634 Simply type groups help [path to command] for full details. 635 636 ``` 637 lakectl auth groups help [command] [flags] 638 ``` 639 640 #### Options 641 {:.no_toc} 642 643 ``` 644 -h, --help help for help 645 ``` 646 647 648 649 ### lakectl auth groups list 650 651 List groups 652 653 ``` 654 lakectl auth groups list [flags] 655 ``` 656 657 #### Options 658 {:.no_toc} 659 660 ``` 661 --amount int how many results to return (default 100) 662 --after string show results after this value (used for pagination) 663 -h, --help help for list 664 ``` 665 666 667 668 ### lakectl auth groups members 669 670 Manage group user memberships 671 672 #### Options 673 {:.no_toc} 674 675 ``` 676 -h, --help help for members 677 ``` 678 679 680 681 ### lakectl auth groups members add 682 683 Add a user to a group 684 685 ``` 686 lakectl auth groups members add [flags] 687 ``` 688 689 #### Options 690 {:.no_toc} 691 692 ``` 693 -h, --help help for add 694 --id string Group identifier 695 --user string Username (email for password-based users, default: current user) 696 ``` 697 698 699 700 ### lakectl auth groups members help 701 702 Help about any command 703 704 #### Synopsis 705 {:.no_toc} 706 707 Help provides help for any command in the application. 708 Simply type members help [path to command] for full details. 709 710 ``` 711 lakectl auth groups members help [command] [flags] 712 ``` 713 714 #### Options 715 {:.no_toc} 716 717 ``` 718 -h, --help help for help 719 ``` 720 721 722 723 ### lakectl auth groups members list 724 725 List users in a group 726 727 ``` 728 lakectl auth groups members list [flags] 729 ``` 730 731 #### Options 732 {:.no_toc} 733 734 ``` 735 --id string Group identifier 736 --amount int how many results to return (default 100) 737 --after string show results after this value (used for pagination) 738 -h, --help help for list 739 ``` 740 741 742 743 ### lakectl auth groups members remove 744 745 Remove a user from a group 746 747 ``` 748 lakectl auth groups members remove [flags] 749 ``` 750 751 #### Options 752 {:.no_toc} 753 754 ``` 755 -h, --help help for remove 756 --id string Group identifier 757 --user string Username (email for password-based users, default: current user) 758 ``` 759 760 761 762 ### lakectl auth groups policies 763 764 Manage group policies 765 766 #### Synopsis 767 {:.no_toc} 768 769 Manage group policies. Requires an external authorization server with matching support. 770 771 #### Options 772 {:.no_toc} 773 774 ``` 775 -h, --help help for policies 776 ``` 777 778 779 780 ### lakectl auth groups policies attach 781 782 Attach a policy to a group 783 784 ``` 785 lakectl auth groups policies attach [flags] 786 ``` 787 788 #### Options 789 {:.no_toc} 790 791 ``` 792 -h, --help help for attach 793 --id string User identifier 794 --policy string Policy identifier 795 ``` 796 797 798 799 ### lakectl auth groups policies detach 800 801 Detach a policy from a group 802 803 ``` 804 lakectl auth groups policies detach [flags] 805 ``` 806 807 #### Options 808 {:.no_toc} 809 810 ``` 811 -h, --help help for detach 812 --id string User identifier 813 --policy string Policy identifier 814 ``` 815 816 817 818 ### lakectl auth groups policies help 819 820 Help about any command 821 822 #### Synopsis 823 {:.no_toc} 824 825 Help provides help for any command in the application. 826 Simply type policies help [path to command] for full details. 827 828 ``` 829 lakectl auth groups policies help [command] [flags] 830 ``` 831 832 #### Options 833 {:.no_toc} 834 835 ``` 836 -h, --help help for help 837 ``` 838 839 840 841 ### lakectl auth groups policies list 842 843 List policies for the given group 844 845 ``` 846 lakectl auth groups policies list [flags] 847 ``` 848 849 #### Options 850 {:.no_toc} 851 852 ``` 853 --id string Group identifier 854 --amount int how many results to return (default 100) 855 --after string show results after this value (used for pagination) 856 -h, --help help for list 857 ``` 858 859 860 861 ### lakectl auth help 862 863 Help about any command 864 865 #### Synopsis 866 {:.no_toc} 867 868 Help provides help for any command in the application. 869 Simply type auth help [path to command] for full details. 870 871 ``` 872 lakectl auth help [command] [flags] 873 ``` 874 875 #### Options 876 {:.no_toc} 877 878 ``` 879 -h, --help help for help 880 ``` 881 882 883 884 ### lakectl auth policies 885 886 Manage policies 887 888 #### Options 889 {:.no_toc} 890 891 ``` 892 -h, --help help for policies 893 ``` 894 895 896 897 ### lakectl auth policies create 898 899 Create a policy 900 901 ``` 902 lakectl auth policies create [flags] 903 ``` 904 905 #### Options 906 {:.no_toc} 907 908 ``` 909 -h, --help help for create 910 --id string Policy identifier 911 --statement-document string JSON statement document path (or "-" for stdin) 912 ``` 913 914 915 916 ### lakectl auth policies delete 917 918 Delete a policy 919 920 ``` 921 lakectl auth policies delete [flags] 922 ``` 923 924 #### Options 925 {:.no_toc} 926 927 ``` 928 -h, --help help for delete 929 --id string Policy identifier 930 ``` 931 932 933 934 ### lakectl auth policies help 935 936 Help about any command 937 938 #### Synopsis 939 {:.no_toc} 940 941 Help provides help for any command in the application. 942 Simply type policies help [path to command] for full details. 943 944 ``` 945 lakectl auth policies help [command] [flags] 946 ``` 947 948 #### Options 949 {:.no_toc} 950 951 ``` 952 -h, --help help for help 953 ``` 954 955 956 957 ### lakectl auth policies list 958 959 List policies 960 961 ``` 962 lakectl auth policies list [flags] 963 ``` 964 965 #### Options 966 {:.no_toc} 967 968 ``` 969 --amount int how many results to return (default 100) 970 --after string show results after this value (used for pagination) 971 -h, --help help for list 972 ``` 973 974 975 976 ### lakectl auth policies show 977 978 Show a policy 979 980 ``` 981 lakectl auth policies show [flags] 982 ``` 983 984 #### Options 985 {:.no_toc} 986 987 ``` 988 -h, --help help for show 989 --id string Policy identifier 990 ``` 991 992 993 994 ### lakectl auth users 995 996 Manage users 997 998 #### Options 999 {:.no_toc} 1000 1001 ``` 1002 -h, --help help for users 1003 ``` 1004 1005 1006 1007 ### lakectl auth users create 1008 1009 Create a user 1010 1011 ``` 1012 lakectl auth users create [flags] 1013 ``` 1014 1015 #### Options 1016 {:.no_toc} 1017 1018 ``` 1019 -h, --help help for create 1020 --id string Username 1021 ``` 1022 1023 1024 1025 ### lakectl auth users credentials 1026 1027 Manage user credentials 1028 1029 #### Options 1030 {:.no_toc} 1031 1032 ``` 1033 -h, --help help for credentials 1034 ``` 1035 1036 1037 1038 ### lakectl auth users credentials create 1039 1040 Create user credentials 1041 1042 ``` 1043 lakectl auth users credentials create [flags] 1044 ``` 1045 1046 #### Options 1047 {:.no_toc} 1048 1049 ``` 1050 -h, --help help for create 1051 --id string Username (email for password-based users, default: current user) 1052 ``` 1053 1054 1055 1056 ### lakectl auth users credentials delete 1057 1058 Delete user credentials 1059 1060 ``` 1061 lakectl auth users credentials delete [flags] 1062 ``` 1063 1064 #### Options 1065 {:.no_toc} 1066 1067 ``` 1068 --access-key-id string Access key ID to delete 1069 -h, --help help for delete 1070 --id string Username (email for password-based users, default: current user) 1071 ``` 1072 1073 1074 1075 ### lakectl auth users credentials help 1076 1077 Help about any command 1078 1079 #### Synopsis 1080 {:.no_toc} 1081 1082 Help provides help for any command in the application. 1083 Simply type credentials help [path to command] for full details. 1084 1085 ``` 1086 lakectl auth users credentials help [command] [flags] 1087 ``` 1088 1089 #### Options 1090 {:.no_toc} 1091 1092 ``` 1093 -h, --help help for help 1094 ``` 1095 1096 1097 1098 ### lakectl auth users credentials list 1099 1100 List user credentials 1101 1102 ``` 1103 lakectl auth users credentials list [flags] 1104 ``` 1105 1106 #### Options 1107 {:.no_toc} 1108 1109 ``` 1110 --id string Username (email for password-based users, default: current user) 1111 --amount int how many results to return (default 100) 1112 --after string show results after this value (used for pagination) 1113 -h, --help help for list 1114 ``` 1115 1116 1117 1118 ### lakectl auth users delete 1119 1120 Delete a user 1121 1122 ``` 1123 lakectl auth users delete [flags] 1124 ``` 1125 1126 #### Options 1127 {:.no_toc} 1128 1129 ``` 1130 -h, --help help for delete 1131 --id string Username (email for password-based users) 1132 ``` 1133 1134 1135 1136 ### lakectl auth users groups 1137 1138 Manage user groups 1139 1140 #### Options 1141 {:.no_toc} 1142 1143 ``` 1144 -h, --help help for groups 1145 ``` 1146 1147 1148 1149 ### lakectl auth users groups help 1150 1151 Help about any command 1152 1153 #### Synopsis 1154 {:.no_toc} 1155 1156 Help provides help for any command in the application. 1157 Simply type groups help [path to command] for full details. 1158 1159 ``` 1160 lakectl auth users groups help [command] [flags] 1161 ``` 1162 1163 #### Options 1164 {:.no_toc} 1165 1166 ``` 1167 -h, --help help for help 1168 ``` 1169 1170 1171 1172 ### lakectl auth users groups list 1173 1174 List groups for the given user 1175 1176 ``` 1177 lakectl auth users groups list [flags] 1178 ``` 1179 1180 #### Options 1181 {:.no_toc} 1182 1183 ``` 1184 --id string Username (email for password-based users) 1185 --amount int how many results to return (default 100) 1186 --after string show results after this value (used for pagination) 1187 -h, --help help for list 1188 ``` 1189 1190 1191 1192 ### lakectl auth users help 1193 1194 Help about any command 1195 1196 #### Synopsis 1197 {:.no_toc} 1198 1199 Help provides help for any command in the application. 1200 Simply type users help [path to command] for full details. 1201 1202 ``` 1203 lakectl auth users help [command] [flags] 1204 ``` 1205 1206 #### Options 1207 {:.no_toc} 1208 1209 ``` 1210 -h, --help help for help 1211 ``` 1212 1213 1214 1215 ### lakectl auth users list 1216 1217 List users 1218 1219 ``` 1220 lakectl auth users list [flags] 1221 ``` 1222 1223 #### Options 1224 {:.no_toc} 1225 1226 ``` 1227 --amount int how many results to return (default 100) 1228 --after string show results after this value (used for pagination) 1229 -h, --help help for list 1230 ``` 1231 1232 1233 1234 ### lakectl auth users policies 1235 1236 Manage user policies 1237 1238 #### Synopsis 1239 {:.no_toc} 1240 1241 Manage user policies. Requires an external authorization server with matching support. 1242 1243 #### Options 1244 {:.no_toc} 1245 1246 ``` 1247 -h, --help help for policies 1248 ``` 1249 1250 1251 1252 ### lakectl auth users policies attach 1253 1254 Attach a policy to a user 1255 1256 ``` 1257 lakectl auth users policies attach [flags] 1258 ``` 1259 1260 #### Options 1261 {:.no_toc} 1262 1263 ``` 1264 -h, --help help for attach 1265 --id string Username (email for password-based users) 1266 --policy string Policy identifier 1267 ``` 1268 1269 1270 1271 ### lakectl auth users policies detach 1272 1273 Detach a policy from a user 1274 1275 ``` 1276 lakectl auth users policies detach [flags] 1277 ``` 1278 1279 #### Options 1280 {:.no_toc} 1281 1282 ``` 1283 -h, --help help for detach 1284 --id string Username (email for password-based users) 1285 --policy string Policy identifier 1286 ``` 1287 1288 1289 1290 ### lakectl auth users policies help 1291 1292 Help about any command 1293 1294 #### Synopsis 1295 {:.no_toc} 1296 1297 Help provides help for any command in the application. 1298 Simply type policies help [path to command] for full details. 1299 1300 ``` 1301 lakectl auth users policies help [command] [flags] 1302 ``` 1303 1304 #### Options 1305 {:.no_toc} 1306 1307 ``` 1308 -h, --help help for help 1309 ``` 1310 1311 1312 1313 ### lakectl auth users policies list 1314 1315 List policies for the given user 1316 1317 ``` 1318 lakectl auth users policies list [flags] 1319 ``` 1320 1321 #### Options 1322 {:.no_toc} 1323 1324 ``` 1325 --effective List all distinct policies attached to the user, including by group memberships 1326 --id string Username (email for password-based users) 1327 --amount int how many results to return (default 100) 1328 --after string show results after this value (used for pagination) 1329 -h, --help help for list 1330 ``` 1331 1332 1333 1334 ### lakectl bisect 1335 1336 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 1337 {: .note .note-warning } 1338 1339 Binary search to find the commit that introduced a bug 1340 1341 #### Options 1342 {:.no_toc} 1343 1344 ``` 1345 -h, --help help for bisect 1346 ``` 1347 1348 1349 1350 ### lakectl bisect bad 1351 1352 Set 'bad' commit that is known to contain the bug 1353 1354 ``` 1355 lakectl bisect bad [flags] 1356 ``` 1357 1358 #### Options 1359 {:.no_toc} 1360 1361 ``` 1362 -h, --help help for bad 1363 ``` 1364 1365 1366 1367 ### lakectl bisect good 1368 1369 Set current commit as 'good' commit that is known to be before the bug was introduced 1370 1371 ``` 1372 lakectl bisect good [flags] 1373 ``` 1374 1375 #### Options 1376 {:.no_toc} 1377 1378 ``` 1379 -h, --help help for good 1380 ``` 1381 1382 1383 1384 ### lakectl bisect help 1385 1386 Help about any command 1387 1388 #### Synopsis 1389 {:.no_toc} 1390 1391 Help provides help for any command in the application. 1392 Simply type bisect help [path to command] for full details. 1393 1394 ``` 1395 lakectl bisect help [command] [flags] 1396 ``` 1397 1398 #### Options 1399 {:.no_toc} 1400 1401 ``` 1402 -h, --help help for help 1403 ``` 1404 1405 1406 1407 ### lakectl bisect log 1408 1409 Print out the current bisect state 1410 1411 ``` 1412 lakectl bisect log [flags] 1413 ``` 1414 1415 #### Options 1416 {:.no_toc} 1417 1418 ``` 1419 -h, --help help for log 1420 ``` 1421 1422 1423 1424 ### lakectl bisect reset 1425 1426 Clean up the bisection state 1427 1428 ``` 1429 lakectl bisect reset [flags] 1430 ``` 1431 1432 #### Options 1433 {:.no_toc} 1434 1435 ``` 1436 -h, --help help for reset 1437 ``` 1438 1439 1440 1441 ### lakectl bisect run 1442 1443 Bisecting based on command status code 1444 1445 ``` 1446 lakectl bisect run <command> [flags] 1447 ``` 1448 1449 #### Options 1450 {:.no_toc} 1451 1452 ``` 1453 -h, --help help for run 1454 ``` 1455 1456 1457 1458 ### lakectl bisect start 1459 1460 Start a bisect session 1461 1462 ``` 1463 lakectl bisect start <bad ref URI> <good ref URI> [flags] 1464 ``` 1465 1466 #### Options 1467 {:.no_toc} 1468 1469 ``` 1470 -h, --help help for start 1471 ``` 1472 1473 1474 1475 ### lakectl bisect view 1476 1477 Current bisect commits 1478 1479 ``` 1480 lakectl bisect view [flags] 1481 ``` 1482 1483 #### Options 1484 {:.no_toc} 1485 1486 ``` 1487 -h, --help help for view 1488 ``` 1489 1490 1491 1492 ### lakectl branch 1493 1494 Create and manage branches within a repository 1495 1496 #### Synopsis 1497 {:.no_toc} 1498 1499 Create delete and list branches within a lakeFS repository 1500 1501 #### Options 1502 {:.no_toc} 1503 1504 ``` 1505 -h, --help help for branch 1506 ``` 1507 1508 1509 1510 ### lakectl branch create 1511 1512 Create a new branch in a repository 1513 1514 ``` 1515 lakectl branch create <branch URI> -s <source ref URI> [flags] 1516 ``` 1517 1518 #### Examples 1519 {:.no_toc} 1520 1521 ``` 1522 lakectl branch create lakefs://example-repo/new-branch -s lakefs://example-repo/main 1523 ``` 1524 1525 #### Options 1526 {:.no_toc} 1527 1528 ``` 1529 -h, --help help for create 1530 -s, --source string source branch uri 1531 ``` 1532 1533 1534 1535 ### lakectl branch delete 1536 1537 Delete a branch in a repository, along with its uncommitted changes (CAREFUL) 1538 1539 ``` 1540 lakectl branch delete <branch URI> [flags] 1541 ``` 1542 1543 #### Examples 1544 {:.no_toc} 1545 1546 ``` 1547 lakectl branch delete lakefs://my-repo/my-branch 1548 ``` 1549 1550 #### Options 1551 {:.no_toc} 1552 1553 ``` 1554 -h, --help help for delete 1555 -y, --yes Automatically say yes to all confirmations 1556 ``` 1557 1558 1559 1560 ### lakectl branch help 1561 1562 Help about any command 1563 1564 #### Synopsis 1565 {:.no_toc} 1566 1567 Help provides help for any command in the application. 1568 Simply type branch help [path to command] for full details. 1569 1570 ``` 1571 lakectl branch help [command] [flags] 1572 ``` 1573 1574 #### Options 1575 {:.no_toc} 1576 1577 ``` 1578 -h, --help help for help 1579 ``` 1580 1581 1582 1583 ### lakectl branch list 1584 1585 List branches in a repository 1586 1587 ``` 1588 lakectl branch list <repository URI> [flags] 1589 ``` 1590 1591 #### Examples 1592 {:.no_toc} 1593 1594 ``` 1595 lakectl branch list lakefs://my-repo 1596 ``` 1597 1598 #### Options 1599 {:.no_toc} 1600 1601 ``` 1602 --after string show results after this value (used for pagination) 1603 --amount int number of results to return (default 100) 1604 -h, --help help for list 1605 ``` 1606 1607 1608 1609 ### lakectl branch reset 1610 1611 Reset uncommitted changes - all of them, or by path 1612 1613 #### Synopsis 1614 {:.no_toc} 1615 1616 reset changes. There are four different ways to reset changes: 1617 1. reset all uncommitted changes - reset lakefs://myrepo/main 1618 2. reset uncommitted changes under specific path - reset lakefs://myrepo/main --prefix path 1619 3. reset uncommitted changes for specific object - reset lakefs://myrepo/main --object path 1620 1621 ``` 1622 lakectl branch reset <branch URI> [--prefix|--object] [flags] 1623 ``` 1624 1625 #### Examples 1626 {:.no_toc} 1627 1628 ``` 1629 lakectl branch reset lakefs://my-repo/my-branch 1630 ``` 1631 1632 #### Options 1633 {:.no_toc} 1634 1635 ``` 1636 -h, --help help for reset 1637 --object string path to object to be reset 1638 --prefix string prefix of the objects to be reset 1639 -y, --yes Automatically say yes to all confirmations 1640 ``` 1641 1642 1643 1644 ### lakectl branch revert 1645 1646 Given a commit, record a new commit to reverse the effect of this commit 1647 1648 #### Synopsis 1649 {:.no_toc} 1650 1651 The commits will be reverted in left-to-right order 1652 1653 ``` 1654 lakectl branch revert <branch URI> <commit ref to revert> [<more commits>...] [flags] 1655 ``` 1656 1657 #### Examples 1658 {:.no_toc} 1659 1660 ``` 1661 lakectl branch revert lakefs://example-repo/example-branch commitA 1662 Revert the changes done by commitA in example-branch 1663 branch revert lakefs://example-repo/example-branch HEAD~1 HEAD~2 HEAD~3 1664 Revert the changes done by the second last commit to the fourth last commit in example-branch 1665 ``` 1666 1667 #### Options 1668 {:.no_toc} 1669 1670 ``` 1671 --allow-empty-commit allow empty commit (revert without changes) 1672 -h, --help help for revert 1673 -m, --parent-number int the parent number (starting from 1) of the mainline. The revert will reverse the change relative to the specified parent. 1674 -y, --yes Automatically say yes to all confirmations 1675 ``` 1676 1677 1678 1679 ### lakectl branch show 1680 1681 Show branch latest commit reference 1682 1683 ``` 1684 lakectl branch show <branch URI> [flags] 1685 ``` 1686 1687 #### Examples 1688 {:.no_toc} 1689 1690 ``` 1691 lakectl branch show lakefs://my-repo/my-branch 1692 ``` 1693 1694 #### Options 1695 {:.no_toc} 1696 1697 ``` 1698 -h, --help help for show 1699 ``` 1700 1701 1702 1703 ### lakectl branch-protect 1704 1705 Create and manage branch protection rules 1706 1707 #### Synopsis 1708 {:.no_toc} 1709 1710 Define branch protection rules to prevent direct changes. Changes to protected branches can only be done by merging from other branches. 1711 1712 #### Options 1713 {:.no_toc} 1714 1715 ``` 1716 -h, --help help for branch-protect 1717 ``` 1718 1719 1720 1721 ### lakectl branch-protect add 1722 1723 Add a branch protection rule 1724 1725 #### Synopsis 1726 {:.no_toc} 1727 1728 Add a branch protection rule for a given branch name pattern 1729 1730 ``` 1731 lakectl branch-protect add <repository URI> <pattern> [flags] 1732 ``` 1733 1734 #### Examples 1735 {:.no_toc} 1736 1737 ``` 1738 lakectl branch-protect add lakefs://my-repo 'stable_*' 1739 ``` 1740 1741 #### Options 1742 {:.no_toc} 1743 1744 ``` 1745 -h, --help help for add 1746 ``` 1747 1748 1749 1750 ### lakectl branch-protect delete 1751 1752 Delete a branch protection rule 1753 1754 #### Synopsis 1755 {:.no_toc} 1756 1757 Delete a branch protection rule for a given branch name pattern 1758 1759 ``` 1760 lakectl branch-protect delete <repository URI> <pattern> [flags] 1761 ``` 1762 1763 #### Examples 1764 {:.no_toc} 1765 1766 ``` 1767 lakectl branch-protect delete lakefs://my-repo stable_* 1768 ``` 1769 1770 #### Options 1771 {:.no_toc} 1772 1773 ``` 1774 -h, --help help for delete 1775 ``` 1776 1777 1778 1779 ### lakectl branch-protect help 1780 1781 Help about any command 1782 1783 #### Synopsis 1784 {:.no_toc} 1785 1786 Help provides help for any command in the application. 1787 Simply type branch-protect help [path to command] for full details. 1788 1789 ``` 1790 lakectl branch-protect help [command] [flags] 1791 ``` 1792 1793 #### Options 1794 {:.no_toc} 1795 1796 ``` 1797 -h, --help help for help 1798 ``` 1799 1800 1801 1802 ### lakectl branch-protect list 1803 1804 List all branch protection rules 1805 1806 ``` 1807 lakectl branch-protect list <repository URI> [flags] 1808 ``` 1809 1810 #### Examples 1811 {:.no_toc} 1812 1813 ``` 1814 lakectl branch-protect list lakefs://my-repo 1815 ``` 1816 1817 #### Options 1818 {:.no_toc} 1819 1820 ``` 1821 -h, --help help for list 1822 ``` 1823 1824 1825 1826 ### lakectl cat-hook-output 1827 1828 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 1829 {: .note .note-warning } 1830 1831 Cat actions hook output 1832 1833 ``` 1834 lakectl cat-hook-output <repository URI> <run_id> <hook_id> [flags] 1835 ``` 1836 1837 #### Examples 1838 {:.no_toc} 1839 1840 ``` 1841 lakectl cat-hook-output lakefs://my-repo 20230719152411arS0z6I my_hook_name 1842 ``` 1843 1844 #### Options 1845 {:.no_toc} 1846 1847 ``` 1848 -h, --help help for cat-hook-output 1849 ``` 1850 1851 1852 1853 ### lakectl cat-sst 1854 1855 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 1856 {: .note .note-warning } 1857 1858 Explore lakeFS .sst files 1859 1860 ``` 1861 lakectl cat-sst <sst-file> [flags] 1862 ``` 1863 1864 #### Options 1865 {:.no_toc} 1866 1867 ``` 1868 --amount int how many records to return, or -1 for all records (default -1) 1869 -f, --file string path to an sstable file, or "-" for stdin 1870 -h, --help help for cat-sst 1871 ``` 1872 1873 1874 1875 ### lakectl cherry-pick 1876 1877 Apply the changes introduced by an existing commit 1878 1879 #### Synopsis 1880 {:.no_toc} 1881 1882 Apply the changes from the given commit to the tip of the branch. The changes will be added as a new commit. 1883 1884 ``` 1885 lakectl cherry-pick <commit URI> <branch> [flags] 1886 ``` 1887 1888 #### Examples 1889 {:.no_toc} 1890 1891 ``` 1892 lakectl cherry-pick lakefs://my-repo/600dc0ffee lakefs://my-repo/my-branch 1893 ``` 1894 1895 #### Options 1896 {:.no_toc} 1897 1898 ``` 1899 -h, --help help for cherry-pick 1900 -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. 1901 ``` 1902 1903 1904 1905 ### lakectl commit 1906 1907 Commit changes on a given branch 1908 1909 ``` 1910 lakectl commit <branch URI> [flags] 1911 ``` 1912 1913 #### Options 1914 {:.no_toc} 1915 1916 ``` 1917 --allow-empty-commit allow a commit with no changes 1918 --allow-empty-message allow an empty commit message 1919 -h, --help help for commit 1920 -m, --message string commit message 1921 --meta strings key value pair in the form of key=value 1922 ``` 1923 1924 1925 1926 ### lakectl completion 1927 1928 Generate completion script 1929 1930 #### Synopsis 1931 {:.no_toc} 1932 1933 To load completions: 1934 1935 Bash: 1936 1937 ```sh 1938 $ source <(lakectl completion bash) 1939 ``` 1940 1941 To load completions for each session, execute once: 1942 Linux: 1943 1944 ```sh 1945 $ lakectl completion bash > /etc/bash_completion.d/lakectl 1946 ``` 1947 1948 MacOS: 1949 1950 ```sh 1951 $ lakectl completion bash > /usr/local/etc/bash_completion.d/lakectl 1952 ``` 1953 1954 Zsh: 1955 1956 If shell completion is not already enabled in your environment you will need 1957 to enable it. You can execute the following once: 1958 1959 ```sh 1960 $ echo "autoload -U compinit; compinit" >> ~/.zshrc 1961 ``` 1962 1963 To load completions for each session, execute once: 1964 ```sh 1965 $ lakectl completion zsh > "${fpath[1]}/_lakectl" 1966 ``` 1967 1968 You will need to start a new shell for this setup to take effect. 1969 1970 Fish: 1971 1972 ```sh 1973 $ lakectl completion fish | source 1974 ``` 1975 1976 To load completions for each session, execute once: 1977 1978 ```sh 1979 $ lakectl completion fish > ~/.config/fish/completions/lakectl.fish 1980 ``` 1981 1982 1983 1984 ``` 1985 lakectl completion <bash|zsh|fish> 1986 ``` 1987 1988 #### Options 1989 {:.no_toc} 1990 1991 ``` 1992 -h, --help help for completion 1993 ``` 1994 1995 1996 1997 ### lakectl config 1998 1999 Create/update local lakeFS configuration 2000 2001 ``` 2002 lakectl config [flags] 2003 ``` 2004 2005 #### Options 2006 {:.no_toc} 2007 2008 ``` 2009 -h, --help help for config 2010 ``` 2011 2012 2013 2014 ### lakectl diff 2015 2016 Show changes between two commits, or the currently uncommitted changes 2017 2018 ``` 2019 lakectl diff <ref URI> [ref URI] [flags] 2020 ``` 2021 2022 #### Examples 2023 {:.no_toc} 2024 2025 ``` 2026 2027 lakectl diff lakefs://example-repo/example-branch 2028 Show uncommitted changes in example-branch. 2029 2030 lakectl diff lakefs://example-repo/main lakefs://example-repo/dev 2031 This shows the differences between master and dev starting at the last common commit. 2032 This is similar to the three-dot (...) syntax in git. 2033 Uncommitted changes are not shown. 2034 2035 lakectl diff --two-way lakefs://example-repo/main lakefs://example-repo/dev 2036 Show changes between the tips of the main and dev branches. 2037 This is similar to the two-dot (..) syntax in git. 2038 Uncommitted changes are not shown. 2039 2040 lakectl diff --two-way lakefs://example-repo/main lakefs://example-repo/dev$ 2041 Show changes between the tip of the main and the dev branch, including uncommitted changes on dev. 2042 ``` 2043 2044 #### Options 2045 {:.no_toc} 2046 2047 ``` 2048 -h, --help help for diff 2049 --two-way Use two-way diff: show difference between the given refs, regardless of a common ancestor. 2050 ``` 2051 2052 2053 2054 ### lakectl docs 2055 2056 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 2057 {: .note .note-warning } 2058 2059 2060 2061 ``` 2062 lakectl docs [outfile] [flags] 2063 ``` 2064 2065 #### Options 2066 {:.no_toc} 2067 2068 ``` 2069 -h, --help help for docs 2070 ``` 2071 2072 2073 2074 ### lakectl doctor 2075 2076 Run a basic diagnosis of the LakeFS configuration 2077 2078 ``` 2079 lakectl doctor [flags] 2080 ``` 2081 2082 #### Options 2083 {:.no_toc} 2084 2085 ``` 2086 -h, --help help for doctor 2087 ``` 2088 2089 2090 2091 ### lakectl find-merge-base 2092 2093 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 2094 {: .note .note-warning } 2095 2096 Find the commits for the merge operation 2097 2098 ``` 2099 lakectl find-merge-base <source ref URI> <destination ref URI> [flags] 2100 ``` 2101 2102 #### Options 2103 {:.no_toc} 2104 2105 ``` 2106 -h, --help help for find-merge-base 2107 ``` 2108 2109 2110 2111 ### lakectl fs 2112 2113 View and manipulate objects 2114 2115 #### Options 2116 {:.no_toc} 2117 2118 ``` 2119 -h, --help help for fs 2120 ``` 2121 2122 2123 2124 ### lakectl fs cat 2125 2126 Dump content of object to stdout 2127 2128 ``` 2129 lakectl fs cat <path URI> [flags] 2130 ``` 2131 2132 #### Options 2133 {:.no_toc} 2134 2135 ``` 2136 -h, --help help for cat 2137 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2138 ``` 2139 2140 2141 2142 ### lakectl fs download 2143 2144 Download object(s) from a given repository path 2145 2146 ``` 2147 lakectl fs download <path URI> [<destination path>] [flags] 2148 ``` 2149 2150 #### Options 2151 {:.no_toc} 2152 2153 ``` 2154 -h, --help help for download 2155 -p, --parallelism int Max concurrent operations to perform (default 25) 2156 --part-size int part size in bytes for multipart download (default 8388608) 2157 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2158 -r, --recursive recursively download all objects under path 2159 ``` 2160 2161 2162 2163 ### lakectl fs help 2164 2165 Help about any command 2166 2167 #### Synopsis 2168 {:.no_toc} 2169 2170 Help provides help for any command in the application. 2171 Simply type fs help [path to command] for full details. 2172 2173 ``` 2174 lakectl fs help [command] [flags] 2175 ``` 2176 2177 #### Options 2178 {:.no_toc} 2179 2180 ``` 2181 -h, --help help for help 2182 ``` 2183 2184 2185 2186 ### lakectl fs ls 2187 2188 List entries under a given tree 2189 2190 ``` 2191 lakectl fs ls <path URI> [flags] 2192 ``` 2193 2194 #### Options 2195 {:.no_toc} 2196 2197 ``` 2198 -h, --help help for ls 2199 -r, --recursive list all objects under the specified path 2200 ``` 2201 2202 2203 2204 ### lakectl fs presign 2205 2206 return a pre-signed URL for reading the specified object 2207 2208 ``` 2209 lakectl fs presign <path URI> [flags] 2210 ``` 2211 2212 #### Options 2213 {:.no_toc} 2214 2215 ``` 2216 -h, --help help for presign 2217 ``` 2218 2219 2220 2221 ### lakectl fs rm 2222 2223 Delete object 2224 2225 ``` 2226 lakectl fs rm <path URI> [flags] 2227 ``` 2228 2229 #### Options 2230 {:.no_toc} 2231 2232 ``` 2233 -C, --concurrency int max concurrent single delete operations to send to the lakeFS server (default 50) 2234 -h, --help help for rm 2235 -r, --recursive recursively delete all objects under the specified path 2236 ``` 2237 2238 2239 2240 ### lakectl fs stage 2241 2242 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 2243 {: .note .note-warning } 2244 2245 Link an external object with a path in a repository 2246 2247 #### Synopsis 2248 {:.no_toc} 2249 2250 Link an external object with a path in a repository, creating an uncommitted change. 2251 The object location must be outside the repository's storage namespace 2252 2253 ``` 2254 lakectl fs stage <path URI> [flags] 2255 ``` 2256 2257 #### Options 2258 {:.no_toc} 2259 2260 ``` 2261 --checksum string Object MD5 checksum as a hexadecimal string 2262 --content-type string MIME type of contents 2263 -h, --help help for stage 2264 --location string fully qualified storage location (i.e. "s3://bucket/path/to/object") 2265 --meta strings key value pairs in the form of key=value 2266 --mtime int Object modified time (Unix Epoch in seconds). Defaults to current time 2267 --size int Object size in bytes 2268 ``` 2269 2270 2271 2272 ### lakectl fs stat 2273 2274 View object metadata 2275 2276 ``` 2277 lakectl fs stat <path URI> [flags] 2278 ``` 2279 2280 #### Options 2281 {:.no_toc} 2282 2283 ``` 2284 -h, --help help for stat 2285 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2286 ``` 2287 2288 2289 2290 ### lakectl fs upload 2291 2292 Upload a local file to the specified URI 2293 2294 ``` 2295 lakectl fs upload <path URI> [flags] 2296 ``` 2297 2298 #### Options 2299 {:.no_toc} 2300 2301 ``` 2302 --content-type string MIME type of contents 2303 -h, --help help for upload 2304 -p, --parallelism int Max concurrent operations to perform (default 25) 2305 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2306 -r, --recursive recursively copy all files under local source 2307 -s, --source string local file to upload, or "-" for stdin 2308 ``` 2309 2310 2311 2312 ### lakectl gc 2313 2314 Manage the garbage collection policy 2315 2316 #### Options 2317 {:.no_toc} 2318 2319 ``` 2320 -h, --help help for gc 2321 ``` 2322 2323 2324 2325 ### lakectl gc delete-config 2326 2327 Deletes the garbage collection policy for the repository 2328 2329 ``` 2330 lakectl gc delete-config <repository URI> [flags] 2331 ``` 2332 2333 #### Examples 2334 {:.no_toc} 2335 2336 ``` 2337 lakectl gc delete-config lakefs://my-repo 2338 ``` 2339 2340 #### Options 2341 {:.no_toc} 2342 2343 ``` 2344 -h, --help help for delete-config 2345 ``` 2346 2347 2348 2349 ### lakectl gc get-config 2350 2351 Show the garbage collection policy for this repository 2352 2353 ``` 2354 lakectl gc get-config <repository URI> [flags] 2355 ``` 2356 2357 #### Examples 2358 {:.no_toc} 2359 2360 ``` 2361 lakectl gc get-config lakefs://my-repo 2362 ``` 2363 2364 #### Options 2365 {:.no_toc} 2366 2367 ``` 2368 -h, --help help for get-config 2369 -p, --json get rules as JSON 2370 ``` 2371 2372 2373 2374 ### lakectl gc help 2375 2376 Help about any command 2377 2378 #### Synopsis 2379 {:.no_toc} 2380 2381 Help provides help for any command in the application. 2382 Simply type gc help [path to command] for full details. 2383 2384 ``` 2385 lakectl gc help [command] [flags] 2386 ``` 2387 2388 #### Options 2389 {:.no_toc} 2390 2391 ``` 2392 -h, --help help for help 2393 ``` 2394 2395 2396 2397 ### lakectl gc set-config 2398 2399 Set garbage collection policy JSON 2400 2401 #### Synopsis 2402 {:.no_toc} 2403 2404 Sets the garbage collection policy JSON. 2405 Example configuration file: 2406 { 2407 "default_retention_days": 21, 2408 "branches": [ 2409 { 2410 "branch_id": "main", 2411 "retention_days": 28 2412 }, 2413 { 2414 "branch_id": "dev", 2415 "retention_days": 14 2416 } 2417 ] 2418 } 2419 2420 ``` 2421 lakectl gc set-config <repository URI> [flags] 2422 ``` 2423 2424 #### Examples 2425 {:.no_toc} 2426 2427 ``` 2428 lakectl gc set-config lakefs://my-repo -f config.json 2429 ``` 2430 2431 #### Options 2432 {:.no_toc} 2433 2434 ``` 2435 -f, --filename string file containing the GC policy as JSON 2436 -h, --help help for set-config 2437 ``` 2438 2439 2440 2441 ### lakectl help 2442 2443 Help about any command 2444 2445 #### Synopsis 2446 {:.no_toc} 2447 2448 Help provides help for any command in the application. 2449 Simply type lakectl help [path to command] for full details. 2450 2451 ``` 2452 lakectl help [command] [flags] 2453 ``` 2454 2455 #### Options 2456 {:.no_toc} 2457 2458 ``` 2459 -h, --help help for help 2460 ``` 2461 2462 2463 2464 ### lakectl import 2465 2466 Import data from external source to a destination branch 2467 2468 ``` 2469 lakectl import --from <object store URI> --to <lakeFS path URI> [flags] 2470 ``` 2471 2472 #### Options 2473 {:.no_toc} 2474 2475 ``` 2476 --allow-empty-message allow an empty commit message (default true) 2477 --from string prefix to read from (e.g. "s3://bucket/sub/path/"). must not be in a storage namespace 2478 -h, --help help for import 2479 -m, --message string commit message 2480 --meta strings key value pair in the form of key=value 2481 --no-progress switch off the progress output 2482 --to string lakeFS path to load objects into (e.g. "lakefs://repo/branch/sub/path/") 2483 ``` 2484 2485 2486 2487 ### lakectl ingest 2488 2489 Ingest objects from an external source into a lakeFS branch (without actually copying them) 2490 2491 ``` 2492 lakectl ingest --from <object store URI> --to <lakeFS path URI> [--dry-run] [flags] 2493 ``` 2494 2495 #### Options 2496 {:.no_toc} 2497 2498 ``` 2499 -C, --concurrency int max concurrent API calls to make to the lakeFS server (default 64) 2500 --dry-run only print the paths to be ingested 2501 --from string prefix to read from (e.g. "s3://bucket/sub/path/"). must not be in a storage namespace 2502 -h, --help help for ingest 2503 --s3-endpoint-url string URL to access S3 storage API (by default, use regular AWS S3 endpoint 2504 --to string lakeFS path to load objects into (e.g. "lakefs://repo/branch/sub/path/") 2505 -v, --verbose print stats for each individual object staged 2506 ``` 2507 2508 2509 2510 ### lakectl local 2511 2512 Sync local directories with lakeFS paths 2513 2514 #### Options 2515 {:.no_toc} 2516 2517 ``` 2518 -h, --help help for local 2519 ``` 2520 2521 2522 2523 ### lakectl local checkout 2524 2525 Sync local directory with the remote state. 2526 2527 ``` 2528 lakectl local checkout [directory] [flags] 2529 ``` 2530 2531 #### Options 2532 {:.no_toc} 2533 2534 ``` 2535 --all Checkout given source branch or reference for all linked directories 2536 -h, --help help for checkout 2537 -p, --parallelism int Max concurrent operations to perform (default 25) 2538 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2539 -r, --ref string Checkout the given reference 2540 -y, --yes Automatically say yes to all confirmations 2541 ``` 2542 2543 2544 2545 ### lakectl local clone 2546 2547 Clone a path from a lakeFS repository into a new directory. 2548 2549 ``` 2550 lakectl local clone <path URI> [directory] [flags] 2551 ``` 2552 2553 #### Options 2554 {:.no_toc} 2555 2556 ``` 2557 --gitignore Update .gitignore file when working in a git repository context (default true) 2558 -h, --help help for clone 2559 -p, --parallelism int Max concurrent operations to perform (default 25) 2560 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2561 ``` 2562 2563 2564 2565 ### lakectl local commit 2566 2567 Commit changes from local directory to the lakeFS branch it tracks. 2568 2569 ``` 2570 lakectl local commit [directory] [flags] 2571 ``` 2572 2573 #### Options 2574 {:.no_toc} 2575 2576 ``` 2577 --allow-empty-message allow an empty commit message 2578 -h, --help help for commit 2579 -m, --message string commit message 2580 --meta strings key value pair in the form of key=value 2581 -p, --parallelism int Max concurrent operations to perform (default 25) 2582 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2583 ``` 2584 2585 2586 2587 ### lakectl local help 2588 2589 Help about any command 2590 2591 #### Synopsis 2592 {:.no_toc} 2593 2594 Help provides help for any command in the application. 2595 Simply type local help [path to command] for full details. 2596 2597 ``` 2598 lakectl local help [command] [flags] 2599 ``` 2600 2601 #### Options 2602 {:.no_toc} 2603 2604 ``` 2605 -h, --help help for help 2606 ``` 2607 2608 2609 2610 ### lakectl local init 2611 2612 set a local directory to sync with a lakeFS path. 2613 2614 ``` 2615 lakectl local init <path URI> [directory] [flags] 2616 ``` 2617 2618 #### Options 2619 {:.no_toc} 2620 2621 ``` 2622 --force Overwrites if directory already linked to a lakeFS path 2623 --gitignore Update .gitignore file when working in a git repository context (default true) 2624 -h, --help help for init 2625 ``` 2626 2627 2628 2629 ### lakectl local list 2630 2631 find and list directories that are synced with lakeFS. 2632 2633 ``` 2634 lakectl local list [directory] [flags] 2635 ``` 2636 2637 #### Options 2638 {:.no_toc} 2639 2640 ``` 2641 -h, --help help for list 2642 ``` 2643 2644 2645 2646 ### lakectl local pull 2647 2648 Fetch latest changes from lakeFS. 2649 2650 ``` 2651 lakectl local pull [directory] [flags] 2652 ``` 2653 2654 #### Options 2655 {:.no_toc} 2656 2657 ``` 2658 --force Reset any uncommitted local change 2659 -h, --help help for pull 2660 -p, --parallelism int Max concurrent operations to perform (default 25) 2661 --pre-sign Use pre-signed URLs when downloading/uploading data (recommended) (default true) 2662 ``` 2663 2664 2665 2666 ### lakectl local status 2667 2668 show modifications (both remote and local) to the directory and the remote location it tracks 2669 2670 ``` 2671 lakectl local status [directory] [flags] 2672 ``` 2673 2674 #### Options 2675 {:.no_toc} 2676 2677 ``` 2678 -h, --help help for status 2679 -l, --local Don't compare against remote changes 2680 ``` 2681 2682 2683 2684 ### lakectl log 2685 2686 Show log of commits 2687 2688 #### Synopsis 2689 {:.no_toc} 2690 2691 Show log of commits for a given branch 2692 2693 ``` 2694 lakectl log <branch URI> [flags] 2695 ``` 2696 2697 #### Examples 2698 {:.no_toc} 2699 2700 ``` 2701 lakectl log --dot lakefs://example-repository/main | dot -Tsvg > graph.svg 2702 ``` 2703 2704 #### Options 2705 {:.no_toc} 2706 2707 ``` 2708 --after string show results after this value (used for pagination) 2709 --amount int number of results to return. By default, all results are returned 2710 --dot return results in a dotgraph format 2711 --first-parent follow only the first parent commit upon seeing a merge commit 2712 -h, --help help for log 2713 --limit limit result just to amount. By default, returns whether more items are available. 2714 --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 2715 --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 2716 --show-meta-range-id also show meta range ID 2717 --since string show results since this date-time (RFC3339 format) 2718 --stop-at string a Ref to stop at (included in results) 2719 ``` 2720 2721 2722 2723 ### lakectl merge 2724 2725 Merge & commit changes from source branch into destination branch 2726 2727 #### Synopsis 2728 {:.no_toc} 2729 2730 Merge & commit changes from source branch into destination branch 2731 2732 ``` 2733 lakectl merge <source ref> <destination ref> [flags] 2734 ``` 2735 2736 #### Options 2737 {:.no_toc} 2738 2739 ``` 2740 --allow-empty-message allow an empty commit message (default true) 2741 -h, --help help for merge 2742 -m, --message string commit message 2743 --meta strings key value pair in the form of key=value 2744 --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 2745 ``` 2746 2747 2748 2749 ### lakectl metastore 2750 2751 Manage metastore commands 2752 2753 #### Options 2754 {:.no_toc} 2755 2756 ``` 2757 -h, --help help for metastore 2758 ``` 2759 2760 2761 2762 ### lakectl metastore copy 2763 2764 Copy or merge table 2765 2766 #### Synopsis 2767 {:.no_toc} 2768 2769 Copy or merge table. the destination table will point to the selected branch 2770 2771 ``` 2772 lakectl metastore copy [flags] 2773 ``` 2774 2775 #### Options 2776 {:.no_toc} 2777 2778 ``` 2779 --catalog-id string Glue catalog ID 2780 --dbfs-root dbfs:/ dbfs location root will replace dbfs:/ in the location before transforming 2781 --from-client-type string metastore type [hive, glue] 2782 --from-schema string source schema name 2783 --from-table string source table name 2784 -h, --help help for copy 2785 --metastore-uri string Hive metastore URI 2786 -p, --partition strings partition to copy 2787 --serde string serde to set copy to [default is to-table] 2788 --to-branch string lakeFS branch name 2789 --to-client-type string metastore type [hive, glue] 2790 --to-schema string destination schema name [default is from-branch] 2791 --to-table string destination table name [default is from-table] 2792 ``` 2793 2794 2795 2796 ### lakectl metastore copy-all 2797 2798 Copy from one metastore to another 2799 2800 #### Synopsis 2801 {:.no_toc} 2802 2803 copy or merge requested tables between hive metastores. the destination tables will point to the selected branch 2804 2805 ``` 2806 lakectl metastore copy-all [flags] 2807 ``` 2808 2809 #### Options 2810 {:.no_toc} 2811 2812 ``` 2813 --branch string lakeFS branch name 2814 --continue-on-error prevent copy-all from failing when a single table fails 2815 --dbfs-root dbfs:/ dbfs location root will replace dbfs:/ in the location before transforming 2816 --from-address string source metastore address 2817 --from-client-type string metastore type [hive, glue] 2818 -h, --help help for copy-all 2819 --schema-filter string filter for schemas to copy in metastore pattern (default ".*") 2820 --table-filter string filter for tables to copy in metastore pattern (default ".*") 2821 --to-address string destination metastore address 2822 --to-client-type string metastore type [hive, glue] 2823 ``` 2824 2825 2826 2827 ### lakectl metastore copy-schema 2828 2829 Copy schema 2830 2831 #### Synopsis 2832 {:.no_toc} 2833 2834 Copy schema (without tables). the destination schema will point to the selected branch 2835 2836 ``` 2837 lakectl metastore copy-schema [flags] 2838 ``` 2839 2840 #### Options 2841 {:.no_toc} 2842 2843 ``` 2844 --catalog-id string Glue catalog ID 2845 --dbfs-root dbfs:/ dbfs location root will replace dbfs:/ in the location before transforming 2846 --from-client-type string metastore type [hive, glue] 2847 --from-schema string source schema name 2848 -h, --help help for copy-schema 2849 --metastore-uri string Hive metastore URI 2850 --to-branch string lakeFS branch name 2851 --to-client-type string metastore type [hive, glue] 2852 --to-schema string destination schema name [default is from-branch] 2853 ``` 2854 2855 2856 2857 ### lakectl metastore create-symlink 2858 2859 Create symlink table and data 2860 2861 #### Synopsis 2862 {:.no_toc} 2863 2864 create table with symlinks, and create the symlinks in s3 in order to access from external services that could only access s3 directly (e.g athena) 2865 2866 ``` 2867 lakectl metastore create-symlink [flags] 2868 ``` 2869 2870 #### Options 2871 {:.no_toc} 2872 2873 ``` 2874 --branch string lakeFS branch name 2875 --catalog-id string Glue catalog ID 2876 --from-client-type string metastore type [hive, glue] 2877 --from-schema string source schema name 2878 --from-table string source table name 2879 -h, --help help for create-symlink 2880 --path string path to table on lakeFS 2881 --repo string lakeFS repository name 2882 --to-schema string destination schema name 2883 --to-table string destination table name 2884 ``` 2885 2886 2887 2888 ### lakectl metastore diff 2889 2890 Show column and partition differences between two tables 2891 2892 ``` 2893 lakectl metastore diff [flags] 2894 ``` 2895 2896 #### Options 2897 {:.no_toc} 2898 2899 ``` 2900 --catalog-id string Glue catalog ID 2901 --from-address string source metastore address 2902 --from-client-type string metastore type [hive, glue] 2903 --from-schema string source schema name 2904 --from-table string source table name 2905 -h, --help help for diff 2906 --metastore-uri string Hive metastore URI 2907 --to-address string destination metastore address 2908 --to-client-type string metastore type [hive, glue] 2909 --to-schema string destination schema name 2910 --to-table string destination table name [default is from-table] 2911 ``` 2912 2913 2914 2915 ### lakectl metastore help 2916 2917 Help about any command 2918 2919 #### Synopsis 2920 {:.no_toc} 2921 2922 Help provides help for any command in the application. 2923 Simply type metastore help [path to command] for full details. 2924 2925 ``` 2926 lakectl metastore help [command] [flags] 2927 ``` 2928 2929 #### Options 2930 {:.no_toc} 2931 2932 ``` 2933 -h, --help help for help 2934 ``` 2935 2936 2937 2938 ### lakectl metastore import-all 2939 2940 Import from one metastore to another 2941 2942 #### Synopsis 2943 {:.no_toc} 2944 2945 2946 import requested tables between hive metastores. the destination tables will point to the selected repository and branch 2947 table with location s3://my-s3-bucket/path/to/table 2948 will be transformed to location s3://repo-param/bucket-param/path/to/table 2949 2950 2951 ``` 2952 lakectl metastore import-all [flags] 2953 ``` 2954 2955 #### Options 2956 {:.no_toc} 2957 2958 ``` 2959 --branch string lakeFS branch name 2960 --continue-on-error prevent import-all from failing when a single table fails 2961 --dbfs-root dbfs:/ dbfs location root will replace dbfs:/ in the location before transforming 2962 --from-address string source metastore address 2963 --from-client-type string metastore type [hive, glue] 2964 -h, --help help for import-all 2965 --repo string lakeFS repo name 2966 --schema-filter string filter for schemas to copy in metastore pattern (default ".*") 2967 --table-filter string filter for tables to copy in metastore pattern (default ".*") 2968 --to-address string destination metastore address 2969 --to-client-type string metastore type [hive, glue] 2970 ``` 2971 2972 2973 2974 ### lakectl refs-dump 2975 2976 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 2977 {: .note .note-warning } 2978 2979 Dumps refs (branches, commits, tags) to the underlying object store 2980 2981 ``` 2982 lakectl refs-dump <repository URI> [flags] 2983 ``` 2984 2985 #### Options 2986 {:.no_toc} 2987 2988 ``` 2989 -h, --help help for refs-dump 2990 -o, --output string output filename (default stdout) 2991 --poll-interval duration poll status check interval (default 3s) 2992 --timeout duration timeout for polling status checks (default 1h0m0s) 2993 ``` 2994 2995 2996 2997 ### lakectl refs-restore 2998 2999 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 3000 {: .note .note-warning } 3001 3002 Restores refs (branches, commits, tags) from the underlying object store to a bare repository 3003 3004 #### Synopsis 3005 {:.no_toc} 3006 3007 restores refs (branches, commits, tags) from the underlying object store to a bare repository. 3008 3009 This command is expected to run on a bare repository (i.e. one created with 'lakectl repo create-bare'). 3010 Since a bare repo is expected, in case of transient failure, delete the repository and recreate it as bare and retry. 3011 3012 ``` 3013 lakectl refs-restore <repository URI> [flags] 3014 ``` 3015 3016 #### Examples 3017 {:.no_toc} 3018 3019 ``` 3020 aws s3 cp s3://bucket/_lakefs/refs_manifest.json - | lakectl refs-restore lakefs://my-bare-repository --manifest - 3021 ``` 3022 3023 #### Options 3024 {:.no_toc} 3025 3026 ``` 3027 -h, --help help for refs-restore 3028 --manifest refs-dump path to a refs manifest json file (as generated by refs-dump). Alternatively, use "-" to read from stdin 3029 --poll-interval duration poll status check interval (default 3s) 3030 --timeout duration timeout for polling status checks (default 1h0m0s) 3031 ``` 3032 3033 3034 3035 ### lakectl repo 3036 3037 Manage and explore repos 3038 3039 #### Options 3040 {:.no_toc} 3041 3042 ``` 3043 -h, --help help for repo 3044 ``` 3045 3046 3047 3048 ### lakectl repo create 3049 3050 Create a new repository 3051 3052 ``` 3053 lakectl repo create <repository URI> <storage namespace> [flags] 3054 ``` 3055 3056 #### Examples 3057 {:.no_toc} 3058 3059 ``` 3060 lakectl repo create lakefs://my-repo s3://my-bucket 3061 ``` 3062 3063 #### Options 3064 {:.no_toc} 3065 3066 ``` 3067 -d, --default-branch string the default branch of this repository (default "main") 3068 -h, --help help for create 3069 ``` 3070 3071 3072 3073 ### lakectl repo create-bare 3074 3075 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 3076 {: .note .note-warning } 3077 3078 Create a new repository with no initial branch or commit 3079 3080 ``` 3081 lakectl repo create-bare <repository URI> <storage namespace> [flags] 3082 ``` 3083 3084 #### Examples 3085 {:.no_toc} 3086 3087 ``` 3088 lakectl create-bare lakefs://my-repo s3://my-bucket 3089 ``` 3090 3091 #### Options 3092 {:.no_toc} 3093 3094 ``` 3095 -d, --default-branch string the default branch name of this repository (will not be created) (default "main") 3096 -h, --help help for create-bare 3097 ``` 3098 3099 3100 3101 ### lakectl repo delete 3102 3103 Delete existing repository 3104 3105 ``` 3106 lakectl repo delete <repository URI> [flags] 3107 ``` 3108 3109 #### Examples 3110 {:.no_toc} 3111 3112 ``` 3113 lakectl repo delete lakefs://my-repo 3114 ``` 3115 3116 #### Options 3117 {:.no_toc} 3118 3119 ``` 3120 -h, --help help for delete 3121 -y, --yes Automatically say yes to all confirmations 3122 ``` 3123 3124 3125 3126 ### lakectl repo help 3127 3128 Help about any command 3129 3130 #### Synopsis 3131 {:.no_toc} 3132 3133 Help provides help for any command in the application. 3134 Simply type repo help [path to command] for full details. 3135 3136 ``` 3137 lakectl repo help [command] [flags] 3138 ``` 3139 3140 #### Options 3141 {:.no_toc} 3142 3143 ``` 3144 -h, --help help for help 3145 ``` 3146 3147 3148 3149 ### lakectl repo list 3150 3151 List repositories 3152 3153 ``` 3154 lakectl repo list [flags] 3155 ``` 3156 3157 #### Options 3158 {:.no_toc} 3159 3160 ``` 3161 --after string show results after this value (used for pagination) 3162 --amount int number of results to return (default 100) 3163 -h, --help help for list 3164 ``` 3165 3166 3167 3168 ### lakectl show 3169 3170 See detailed information about an entity 3171 3172 #### Options 3173 {:.no_toc} 3174 3175 ``` 3176 -h, --help help for show 3177 ``` 3178 3179 3180 3181 ### lakectl show commit 3182 3183 See detailed information about a commit 3184 3185 ``` 3186 lakectl show commit <commit URI> [flags] 3187 ``` 3188 3189 #### Options 3190 {:.no_toc} 3191 3192 ``` 3193 -h, --help help for commit 3194 --show-meta-range-id show meta range ID 3195 ``` 3196 3197 3198 3199 ### lakectl show help 3200 3201 Help about any command 3202 3203 #### Synopsis 3204 {:.no_toc} 3205 3206 Help provides help for any command in the application. 3207 Simply type show help [path to command] for full details. 3208 3209 ``` 3210 lakectl show help [command] [flags] 3211 ``` 3212 3213 #### Options 3214 {:.no_toc} 3215 3216 ``` 3217 -h, --help help for help 3218 ``` 3219 3220 3221 3222 ### lakectl tag 3223 3224 Create and manage tags within a repository 3225 3226 #### Synopsis 3227 {:.no_toc} 3228 3229 Create delete and list tags within a lakeFS repository 3230 3231 #### Options 3232 {:.no_toc} 3233 3234 ``` 3235 -h, --help help for tag 3236 ``` 3237 3238 3239 3240 ### lakectl tag create 3241 3242 Create a new tag in a repository 3243 3244 ``` 3245 lakectl tag create <tag URI> <commit URI> [flags] 3246 ``` 3247 3248 #### Examples 3249 {:.no_toc} 3250 3251 ``` 3252 lakectl tag create lakefs://example-repo/example-tag lakefs://example-repo/2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917 3253 ``` 3254 3255 #### Options 3256 {:.no_toc} 3257 3258 ``` 3259 -f, --force override the tag if it exists 3260 -h, --help help for create 3261 ``` 3262 3263 3264 3265 ### lakectl tag delete 3266 3267 Delete a tag from a repository 3268 3269 ``` 3270 lakectl tag delete <tag URI> [flags] 3271 ``` 3272 3273 #### Options 3274 {:.no_toc} 3275 3276 ``` 3277 -h, --help help for delete 3278 ``` 3279 3280 3281 3282 ### lakectl tag help 3283 3284 Help about any command 3285 3286 #### Synopsis 3287 {:.no_toc} 3288 3289 Help provides help for any command in the application. 3290 Simply type tag help [path to command] for full details. 3291 3292 ``` 3293 lakectl tag help [command] [flags] 3294 ``` 3295 3296 #### Options 3297 {:.no_toc} 3298 3299 ``` 3300 -h, --help help for help 3301 ``` 3302 3303 3304 3305 ### lakectl tag list 3306 3307 List tags in a repository 3308 3309 ``` 3310 lakectl tag list <repository URI> [flags] 3311 ``` 3312 3313 #### Examples 3314 {:.no_toc} 3315 3316 ``` 3317 lakectl tag list lakefs://my-repo 3318 ``` 3319 3320 #### Options 3321 {:.no_toc} 3322 3323 ``` 3324 --after string show results after this value (used for pagination) 3325 --amount int number of results to return (default 100) 3326 -h, --help help for list 3327 ``` 3328 3329 3330 3331 ### lakectl tag show 3332 3333 Show tag's commit reference 3334 3335 ``` 3336 lakectl tag show <tag URI> [flags] 3337 ``` 3338 3339 #### Options 3340 {:.no_toc} 3341 3342 ``` 3343 -h, --help help for show 3344 ``` 3345 3346 3347 3348 ### lakectl usage 3349 3350 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 3351 {: .note .note-warning } 3352 3353 Usage reports from lakeFS 3354 3355 #### Options 3356 {:.no_toc} 3357 3358 ``` 3359 -h, --help help for usage 3360 ``` 3361 3362 3363 3364 ### lakectl usage help 3365 3366 Help about any command 3367 3368 #### Synopsis 3369 {:.no_toc} 3370 3371 Help provides help for any command in the application. 3372 Simply type usage help [path to command] for full details. 3373 3374 ``` 3375 lakectl usage help [command] [flags] 3376 ``` 3377 3378 #### Options 3379 {:.no_toc} 3380 3381 ``` 3382 -h, --help help for help 3383 ``` 3384 3385 3386 3387 ### lakectl usage summary 3388 3389 **note:** This command is a lakeFS plumbing command. Don't use it unless you're really sure you know what you're doing. 3390 {: .note .note-warning } 3391 3392 Summary reports from lakeFS 3393 3394 ``` 3395 lakectl usage summary [flags] 3396 ``` 3397 3398 #### Options 3399 {:.no_toc} 3400 3401 ``` 3402 -h, --help help for summary 3403 ``` 3404 3405 3406