aepctl

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 7, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

README

aepctl

aepctl is a command line tool for the Adobe Experience Platform implementing a part of the REST API.

This is the initial state of this project and no release is available.

Overview

aepctl is a complement to the existing web interface and has been developed for advanced users as well as developers. In combination with activated syntax completion, aepctl accelerates the execution of repeating tasks, prototyping and learning the APIs.

Status of Implementation

At the moment the following APIs are implemented:

Planed APIs:

  • Catalog Service API

Quick Start

  1. Install aepctl
    • macOS 
      brew install fuxs/formulae/aepctl
    • Windows (requires PowerShell) 
      Invoke-WebRequest https://www.bungenstock.de/aepctl/releases/v0.1.1/windows/amd64/aepctl.exe -OutFile aepctl.exe
      Add aepctl.exe to your PATH
  2. Create an Adobe I/O Project (detailed documentation)
  3. Provide a config.yaml file with the following command 
    aepctl configure
    Paste authentication credentials from the Adobe I/O project (click on Service Account(JWT) of your Adobe I/O project) and select a private key file. (detailed documentation)
  4. Test the configuration by getting an access token. 
    aepctl get token

Installation

macOS

The recommended installation method is homebrew. Visit the website and install it if you haven't already.

Run the following command to install aepctl:

brew install fuxs/formulae/aepctl
zsh completion

The zsh is the default shell since macOS 10.15 Catalina and provides strong completion capabilities. It is recommended to activate completions for aepctl in order to ease the input with complex ids or names.

Windows

PowerShell

Open the PowerShell and follow the instructions:

  1. Download the latest pre-release aepctl v0.1.1 or use Invoke-WebRequest:
Invoke-WebRequest https://www.bungenstock.de/aepctl/releases/v0.1.1/windows/amd64/aepctl.exe -OutFile aepctl.exe
  1. The validation of the binary is optional (go to step 4 if you want to skip it). Download the SHA256 file or use Invoke-WebRequest:
Invoke-WebRequest https://www.bungenstock.de/aepctl/releases/v0.1.1/windows/amd64/aepctl.exe.sha256 -OutFile aepctl.exe.sha256
  1. Check the integrity with the following command. You should get the value True as result.
(Get-FileHash aepctl.exe).Hash -eq (Get-Content aepctl.exe.sha256)

  1. Add the aepctl.exe to your PATH

  2. Test that everything is working by opening the help.

aepctl --help

License

aepctl is released under the Apache 2.0 license.

Documentation

Overview

Package main consists only of this file

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.

Source Files

View all Source files

Directories

Path Synopsis
api
Package api is the base for all aep rest functions.
 Package api is the base for all aep rest functions.
acl
Package acl consists of access control list functions.
 Package acl consists of access control list functions.
catalog
Package catalog consists of catalog functions.
 Package catalog consists of catalog functions.
od
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
sandbox
Package sandbox contains all sandbox related functions.
 Package sandbox contains all sandbox related functions.
sr
Package token contains all token related functions.
 Package token contains all token related functions.
token
Package token contains all token related functions.
 Package token contains all token related functions.
Package cache consists of all caching relted functions and data structures.
 Package cache consists of all caching relted functions and data structures.
cmd
Package cmd is the root package for aepctl.
 Package cmd is the root package for aepctl.
completion
Package completion manages all completion related operations.
 Package completion manages all completion related operations.
configure
Package configure contains the configuration command
 Package configure contains the configuration command
create
Package create is the base for all create commands.
 Package create is the base for all create commands.
create/catalog
create/od
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
delete
Package delete is the base for all delete commands.
 Package delete is the base for all delete commands.
delete/od
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
download
Package cmd is the root package for aepctl.
 Package cmd is the root package for aepctl.
get
Package get contains get command related functions.
 Package get contains get command related functions.
get/catalog
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
get/da
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
get/flow
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
get/od
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
get/sr
get/ups
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
helper
Package helper consists of helping functions.
 Package helper consists of helping functions.
update
Package update contains update command related functions.
 Package update contains update command related functions.
update/od
Package od contains offer decisiong related functions.
 Package od contains offer decisiong related functions.
version
Package version contains the version comman
 Package version contains the version comman
Package ui consists of console ui components
 Package ui consists of console ui components
Package util util consists of general utility functions and structures.
 Package util util consists of general utility functions and structures.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.