gergaji
0.4.2
Meskipun AWS CLI adalah sumber daya yang bagus untuk mengelola layanan yang didukung AWS, sulit untuk mengingat penggunaan :
SAWS bertujuan untuk meningkatkan AWS CLI dengan fitur-fitur yang berfokus pada:
Pada dasarnya, SAWS didukung oleh AWS CLI dan mendukung perintah dan struktur perintah yang sama.
Penggunaan SAWS dan AWS CLI :
aws [parameters] [options]
Fitur SAWS :
SAWS tersedia untuk Mac, Linux, Unix, dan Windows.
Anda dapat mengontrol tema mana yang akan dimuat untuk penyorotan sintaksis dengan memperbarui file ~/.sawsrc Anda:
# Visual theme. Possible values: manni, igor, xcode, vim, autumn, vs, rrt,
# native, perldoc, borland, tango, emacs, friendly, monokai, paraiso-dark,
# colorful, murphy, bw, pastie, paraiso-light, trac, default, fruity
theme = vim
SAWS menyediakan pelengkapan otomatis cerdas saat Anda mengetik. Memasukkan perintah berikut akan secara interaktif mencantumkan dan melengkapi otomatis semua subperintah khusus hanya untuk ec2 :
aws ec2
Selain perintah, subperintah, dan opsi default yang disediakan AWS CLI, SAWS mendukung penyelesaian otomatis sumber daya AWS Anda. Saat ini, nama bucket, id instans, dan tag instans disertakan, dengan dukungan tambahan untuk lebih banyak sumber daya yang sedang dikembangkan.
Opsi untuk s3api :
--bucket
Contoh Penggunaan:
aws s3api get-bucket-acl --bucket
Sintaks untuk s3 :
s3://
Contoh Penggunaan:
aws s3 ls s3://
Catatan: Contoh di bawah ini menunjukkan penggunaan penyelesaian sumber daya fuzzy:
Opsi untuk ec2 :
--instance-ids
Contoh Penggunaan:
aws ec2 describe-instances --instance-ids
aws ec2 ls --instance-ids
Catatan: Perintah ls mendemonstrasikan penggunaan pintasan yang dapat disesuaikan:
Opsi untuk ec2 :
--ec2-tag-key
--ec2-tag-value
Contoh Penggunaan:
aws ec2 ls --ec2-tag-key
aws ec2 ls --ec2-tag-value
Tag mendukung wildcard dengan karakter * .
Catatan: ls , --ec2-tag-value , dan --ec2-tag-key mendemonstrasikan penggunaan pintasan yang dapat disesuaikan:
Jangan ragu untuk mengirimkan masalah atau permintaan penarikan jika Anda menginginkan dukungan untuk sumber daya tambahan.
File ~/.saws.shortcuts berisi pintasan yang dapat Anda modifikasi. Itu sudah diisi sebelumnya dengan beberapa pintasan praktis di luar kotak. Anda dapat menggabungkan pintasan dengan penyelesaian fuzzy untuk penekanan tombol yang lebih sedikit. Berikut adalah beberapa contohnya.
Daftar semua instans EC2:
aws ec2 ls
Daftar semua instans EC2 yang berjalan:
aws ec2 ls --ec2-state running # fuzzy shortcut: aws ecstate
Cantumkan semua instans EC2 dengan tag yang cocok (mendukung wildcard * ):
aws ec2 ls --ec2-tag-key # fuzzy shortcut: aws ectagk
aws ec2 ls --ec2-tag-value # fuzzy shortcut: aws ectagv
Cantumkan instans EC2 dengan id yang cocok:
aws ec2 ls --instance-ids # fuzzy shortcut: aws eclsi
Daftar semua tabel DynamoDB:
aws dynamodb ls # fuzzy shortcut: aws dls
Daftar semua cluster EMR:
aws emr ls # fuzzy shortcut: aws emls
Tambahkan/hapus/modifikasi pintasan di file ~/.saws.shortcuts sesuai kebutuhan Anda.
Jangan ragu untuk mengirimkan:
Untuk mengaktifkan penyelesaian sumber daya dan pintasan AWS yang tidak jelas, gunakan kunci F3 .
Contoh pintasan fuzzy untuk memulai dan menghentikan instans EC2:
aws ecstop
aws ecstart
Catatan: Penyelesaian fuzzy saat ini hanya berfungsi dengan sumber daya dan pintasan AWS.
SAWS mendukung saran otomatis gaya Ikan. Gunakan tombol right arrow untuk menyelesaikan saran.
SAWS memungkinkan Anda menjalankan perintah shell dari prompt saws> .
SAWS melacak perintah yang Anda masukkan dan menyimpannya di ~/.saws-history . Gunakan tombol panah atas dan bawah untuk menelusuri riwayat perintah.
SAWS mendukung help baris perintah kontekstual dan docs web kontekstual.
Perintah help didukung oleh AWS CLI dan mengeluarkan bantuan dalam baris perintah.
Penggunaan:
aws help
Terkadang Anda tidak yakin kombinasi perintah/subperintah/opsi spesifik apa yang perlu Anda gunakan. Dalam kasus seperti itu, menelusuri beberapa kombinasi dengan baris perintah help lebih rumit dibandingkan menelusuri dokumen AWS CLI online melalui browser web.
SAWS mendukung dokumen web kontekstual dengan perintah docs atau tombol F9 . SAWS akan menampilkan dokumen web khusus untuk perintah dan subperintah yang dimasukkan saat ini.
Penggunaan:
aws docs
SAWS mendukung sejumlah opsi toolbar:
F2 mengaktifkan penyorotan sintaks keluaranF3 mengaktifkan penyelesaian sumber daya dan pintasan AWS yang tidak jelasF4 mengaktifkan penyelesaian pintasanF5 menyegarkan sumber daya untuk penyelesaian otomatisF9 menampilkan dokumen web kontekstualF10 atau control d keluar dari SAWS SAWS telah diuji pada Windows 7 dan Windows 10.
Di Windows, file .sawsrc dapat ditemukan di %userprofile% . Misalnya:
C:Usersdmartin.sawsrc
Meskipun Anda dapat menggunakan command prompt Windows standar, Anda mungkin akan memiliki pengalaman yang lebih baik dengan cmder atau conemu.
SAWS dihosting di PyPI. Perintah berikut akan menginstal SAWS bersama dengan dependensi seperti AWS CLI:
$ pip install saws
Anda juga dapat menginstal SAWS terbaru dari sumber GitHub yang dapat berisi perubahan yang belum diterapkan ke PyPI:
$ pip install git+https://github.com/donnemartin/saws.git
Jika Anda tidak menginstal di virtualenv, jalankan dengan sudo :
$ sudo pip install saws
Setelah terinstal, mulai SAWS :
$ saws
Disarankan agar Anda menginstal paket Python di virtualenv untuk menghindari potensi masalah dengan dependensi atau izin.
Untuk melihat petunjuk instalasi SAWS virtualenv dan Docker, klik di sini.
Ada masalah umum dengan Apple dan dependensi paket python yang disertakan (info lebih lanjut di pypa/pip#3165). Kami sedang menyelidiki cara untuk memperbaiki masalah ini tetapi sementara itu, untuk memasang gergaji, Anda dapat menjalankan:
$ sudo pip install saws --upgrade --ignore-installed six
Konfigurasikan kredensial Anda dengan AWS CLI:
$ aws configure
Jika Anda ingin menggunakan profil bernama tertentu dengan SAWS , jalankan perintah berikut di OS X, Linux, atau Unix:
$ export AWS_DEFAULT_PROFILE=user1
$ saws
Atau sebagai satu kalimat:
$ AWS_DEFAULT_PROFILE=user1 saws
Pengguna Windows dapat menjalankan perintah berikut:
> set AWS_DEFAULT_PROFILE=user1
> saws
Opsi baris perintah untuk memulai SAWS dengan profil tertentu sedang dikembangkan. Untuk detail selengkapnya tentang cara menginstal dan mengonfigurasi AWS CLI, lihat dokumentasi berikut.
Pengujian ringan menunjukkan bahwa SAWS juga tampaknya kompatibel dengan Python 3.5.
Pypy3 tidak didukung karena kurangnya dukungan dari boto.
Jika Anda tertarik berkontribusi pada SAWS , jalankan perintah berikut:
$ git clone https://github.com/donnemartin/saws.git
$ pip install -e .
$ pip install -r requirements-dev.txt
$ saws
Detail integrasi berkelanjutan tersedia di Travis CI.
Detail manajemen dependensi tersedia di Gemnasium.
Jalankan pengujian unit di lingkungan Python aktif Anda:
$ python tests/run_tests.py
Jalankan pengujian unit dengan tox di beberapa lingkungan Python:
$ tox
Dokumentasi kode sumber tersedia di Readthedocs.org.
Jalankan perintah berikut untuk membuat dokumen:
$ scripts/update_docs.sh
Kontribusi dipersilakan!
Tinjau Pedoman Berkontribusi untuk mengetahui detail tentang cara:
SAWSSAWSSAWS dan beberapa fungsi utilitas praktis Jangan ragu untuk menghubungi saya untuk mendiskusikan masalah, pertanyaan, atau komentar apa pun.
Saya memberikan kode dan sumber daya dalam repositori ini kepada Anda di bawah lisensi sumber terbuka. Karena ini adalah repositori pribadi saya, lisensi yang Anda terima atas kode dan sumber daya saya berasal dari saya dan bukan perusahaan saya (Facebook).
Copyright 2015 Donne Martin
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
