https://github.com/cniles/axe

AWS Extensions for Emacs
https://github.com/cniles/axe

aws emacs

Last synced: about 14 hours ago
JSON representation

AWS Extensions for Emacs

• Host: GitHub
• URL: https://github.com/cniles/axe
• Owner: cniles
• License: gpl-3.0
• Created: 2020-08-13T04:06:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-20T17:55:35.000Z (over 1 year ago)
• Last Synced: 2024-04-23T14:13:37.702Z (7 months ago)
• Topics: aws, emacs
• Language: Emacs Lisp
• Homepage:
• Size: 105 KB
• Stars: 42
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Test & Lint](https://github.com/cniles/axe/actions/workflows/ci.yml/badge.svg)](https://github.com/cniles/axe/actions) [![MELPA](https://melpa.org/packages/axe-badge.svg)](https://melpa.org/#/axe)

# axe

AWS eXtensions for Emacs

# Introduction

axe lets you use Emacs as a frontend for interacting with AWS

resources.  It makes available a number of tasks, such as listing

buckets, invoking lambdas and tailing logs, ergonomically available

through emacs.

The package relies on the AWS APIs, rather than the CLI.  The

reasoning behind this design decision (rather than depending on the

AWS CLI) are:

0. The AWS CLI utility is no longer a runtime dependency.

1. The AWS CLI utility v1 and v2 have version differences

2. The AWS APIs are platform independent.

3. AXE can more easily control when updating to a new API version

   rather than dealing with current and future breaking changes

   between AWS CLI versions

4. The AWS APIs provide a more consistent response structure to

   operate upon.

This project is in a very early form.  A lot of things may change.

Breaking changes to the interactive functions will be avoided.

However, implementing against some of the internal interfaces could

possibly cause some heartburn with future changes.

# Setup

The variables `axe-access-key-id` and `axe-secret-access-key` can be

defined to set access key id and secret access key.  If not specified,

these values will be read from the AWS credential file set to

`aws-credential-file`, which defaults to the

`/.aws/credentials`.

A profile can be set using `axe-profile` (defaults to 'default').

# Keybindings

Keybindings to specific interactive should be implemented by the

user. There isn't currently a recommended list.

The `axe-api-response-list-mode` does provide a set of keybindings for dealing

with API responses.

0. `n`: Request and display the next API response using the next token

   from the latest response.

1. `N`: Enable auto-follow in the buffer.  If a next token is provided

   in an API response, the next response will be requested and

   displayed after a configured delay.

2. `s`: Stop auto-following.

Additional keybindings may be added by use case.

# Roadmap

- STS API https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html

- Make requests with assumed role

- Documentation needs work

- IAM -- view roles, policies, users, etc.