├── .github └── workflows │ └── ci.yml ├── Dockerfile ├── LICENSE.md ├── README.md ├── doc └── demo.gif └── s3-fuzzy-viewer /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: [ "master", "dev" ] 6 | pull_request: 7 | branches: [ "master", "dev" ] 8 | 9 | jobs: 10 | 11 | ci: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | - name: Build image 16 | run: | 17 | # Login dockerhub 18 | pwd="${{ secrets.dockerhub }}" 19 | docker login -u="plazzari" -p="${pwd}" 20 | 21 | # Get version 22 | VERSION=$(awk -F '[="]' '/^VERSION/ {print $3}' s3-fuzzy-viewer) 23 | 24 | # Build docker images 25 | docker build . --tag "plazzari/s3-fuzzy-viewer:${VERSION}" 26 | docker tag "plazzari/s3-fuzzy-viewer:${VERSION}" plazzari/s3-fuzzy-viewer:latest 27 | 28 | # Deploy docker images 29 | docker push "plazzari/s3-fuzzy-viewer:${VERSION}" 30 | docker push plazzari/s3-fuzzy-viewer:latest 31 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu 2 | 3 | ENV fzf_version="0.37.0" 4 | ENV awscli_version="1.27.60" 5 | 6 | RUN apt-get update && \ 7 | apt-get install -y curl python3.10 python3-pip tmux && \ 8 | curl -sOL "https://github.com/junegunn/fzf/releases/download/${fzf_version}/fzf-${fzf_version}-linux_amd64.tar.gz" && tar -xvzf "fzf-${fzf_version}-linux_amd64.tar.gz" && cp fzf /usr/local/bin/fzf && chmod +x /usr/local/bin/fzf && \ 9 | pip install "awscli==${awscli_version}" 10 | 11 | ADD s3-fuzzy-viewer . 12 | RUN chmod +x s3-fuzzy-viewer 13 | ENTRYPOINT ["./s3-fuzzy-viewer"] -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # s3-fuzzy-viewer 2 | 3 | s3-fuzzy-viewer is a cli tool that allows you to search for s3 objects using fuzzy search 4 | 5 | ![demo](doc/demo.gif) 6 | 7 | 8 | ## Usage 9 | 10 | ```bash 11 | s3-fuzzy-viewer 12 | ``` 13 | 14 | or, using docker: 15 | 16 | ```bash 17 | docker run --rm -it -v ~/.aws:/root/.aws:ro plazzari/s3-fuzzy-viewer:latest 18 | ``` 19 | 20 | - to move between the two windows, use tab 21 | - to select the bucket of interest, press enter in the first window 22 | - to scroll the content of the selected object up and down, use shift+up or shift+down 23 | - to exit printing to stdout the selected object, press enter 24 | - to kill, use ctrl+c or ctrl+d 25 | - to make the focused window smaller or larger, use ctrl-b + < or ctrl-b + > 26 | 27 | ## Prerequisites 28 | 29 | - [awscli](https://github.com/aws/aws-cli) 30 | - [fzf](https://github.com/junegunn/fzf) 31 | - tmux 32 | 33 | ## Installation 34 | 35 | ```bash 36 | curl -O https://raw.githubusercontent.com/paololazzari/s3-fuzzy-viewer/master/s3-fuzzy-viewer 37 | cp s3-fuzzy-viewer /usr/local/bin/s3-fuzzy-viewer 38 | chmod +x /usr/local/bin/s3-fuzzy-viewer 39 | ``` -------------------------------------------------------------------------------- /doc/demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paololazzari/s3-fuzzy-viewer/cd3e22f0c8eaa576cd1e53a46aa6d21d409ee0c3/doc/demo.gif -------------------------------------------------------------------------------- /s3-fuzzy-viewer: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | VERSION="0.1.0" 3 | 4 | print_version() 5 | { 6 | echo "s3-fuzzy-viewer version $VERSION" 7 | } 8 | 9 | print_options() 10 | { 11 | echo "s3-fuzzy-viewer [version $VERSION]" 12 | echo "Usage: " 13 | echo " -h, --help : Display this message" 14 | echo " -v, --version: Display the version of s3-fuzzy-viewer" 15 | } 16 | 17 | _validate_prerequisites () { 18 | # make sure tmux is installed 19 | which tmux &> /dev/null 20 | if [[ "$?" -ne 0 ]]; then 21 | echo "tmux is not installed" 22 | exit 1 23 | fi 24 | 25 | # make sure aws cli is installed 26 | which aws &> /dev/null 27 | if [[ "$?" -ne 0 ]]; then 28 | echo "aws cli is not installed" 29 | exit 1 30 | fi 31 | 32 | # make sure fzf is installed 33 | which fzf &> /dev/null 34 | if [[ "$?" -ne 0 ]]; then 35 | echo "fzf is not installed" 36 | exit 1 37 | fi 38 | } 39 | 40 | # parse command line arguments 41 | while [[ "$#" -gt 0 ]]; do 42 | case $1 in 43 | -h|--help) print_options; exit 0 ;; 44 | -v|--version) print_version; exit 0 ;; 45 | *) echo "Unknown parameter passed: $1" && exit 1;; 46 | esac 47 | shift 48 | done 49 | 50 | function cleanup 51 | { 52 | # on exit, kill the tmux session 53 | tmux kill-session -t "${sessionname}" &> /dev/null 54 | 55 | if [ -f /tmp/_exited ]; then 56 | head -n -1 /tmp/_obj 57 | fi 58 | 59 | # clean up 60 | rm /tmp/_obj /tmp/_bucket /tmp/_objname &> /dev/null 61 | rm /tmp/_exited &> /dev/null 62 | } 63 | 64 | trap cleanup EXIT 65 | 66 | echo "Fetching buckets..." 67 | export buckets=$(aws s3 ls | awk '{print $3}') 68 | 69 | # define variables to name the tmux session 70 | timestamp=$(date +%Y%m%dT%H%M%SZ) 71 | socketname="s3fuzzyviewersocket${timestamp}" 72 | sessionname="s3fuzzyviewersession${timestamp}" 73 | 74 | # create a new tmux socket 75 | tmux -L "${socketname}" new-session -s "${sessionname}" -d \; 76 | tmux -L "${socketname}" split-window -h -p 80 77 | 78 | # bind the tab key to cycle across panes 79 | tmux -L "${socketname}" bind-key -n Tab select-pane -R 80 | 81 | # bind ctrl+c and cltr+d keys to kill the program 82 | tmux -L "${socketname}" bind-key -n C-C kill-server &> /dev/null 83 | tmux -L "${socketname}" bind-key -n C-D kill-server &> /dev/null 84 | 85 | tmux -L "${socketname}" send-keys -t 0 ' 86 | echo "$buckets" | fzf --bind '"'enter:execute-silent[ 87 | echo {} > /tmp/_bucket 88 | tmux setenv SELECTED_BUCKET {} 89 | tmux send-keys -t 1 "DC" 90 | tmux send-keys -t 1 "Escape" 91 | ]'"' 92 | ' C-m 93 | 94 | tmux -L "${socketname}" send-keys -t 1 ' 95 | FZF_DEFAULT_COMMAND="echo \"Select a bucket\"" \ 96 | fzf --bind '"'ctrl-r:reload[eval \"\$FZF_DEFAULT_COMMAND\"]'"' \ 97 | --bind '"'del:clear-query'"' \ 98 | --bind '"'esc:reload[bucket=\$(tmux show-env | awk -F= \"/SELECTED_BUCKET/ {print \\\$2}\"); obj=\$(aws s3 ls \"s3://\$bucket\" --recursive | awk \"\\\$3 > 0 {print \\\$4}\"); echo \"\$obj\"]'"' \ 99 | --bind '"'enter:execute-silent[bucket=\$(tmux show-env | awk -F= \"/SELECTED_BUCKET/ {print \\\$2}\"); objname=\$( /tmp/_objname; if grep \"Select a bucket\" <<<{}; then :; else bucket=\$(tmux show-env | awk -F= \"/SELECTED_BUCKET/ {print \\\$2}\"); if grep -E \"^$\" <<<\${l}; then echo \"This bucket is empty\"; else aws s3 cp \"s3://\${bucket}/\${l}\" - 2>/dev/null | tee /tmp/_obj; echo -e \"\\n\$l\" >> /tmp/_obj; fi; fi'"' 101 | ' C-m 102 | 103 | tmux -L "${socketname}" select-pane -t 0 104 | tmux -L "${socketname}" attach-session &>/dev/null 105 | --------------------------------------------------------------------------------