Download the PHP package owowagency/wordsmith-cli without Composer

On this page you can find all versions of the php package owowagency/wordsmith-cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package wordsmith-cli

Wordsmith CLI

  1. Usage
    1. NPM
    2. Composer
    3. Github actions
  2. Commands
    1. List projects
    2. Pull
    3. Push
  3. Configuration
    1. Top level
    2. Targets
    3. Supported formats
  4. Example configuration

Usage

NPM

You can use the CLI using npx or by installing it with your preferred package manager:

You can also install it per project and use it as a script:

Then add the following to your package.json:

Composer

To use the CLI using composer, install it using:

Then add the following to your composer.json:

Github actions

To use the CLI in Github actions, use the wordsmith-action

Commands

List Projects

Lists all projects in the scope of the access token, which can be configured in wordsmith.yml, see Configuration

short long type default description
-e --env String wordsmith.yml Path to the configuration file
--access-token String wordsmith.yml Access token
--verbose Bool false Enables verbose logging

Pull

Pulls translation files from the API, translation files can be configured in wordsmith.yml, see Configuration

short long type default description
-e --env String wordsmith.yml Path to the configuration file
--access-token String wordsmith.yml Access token
--verbose Bool false Enables verbose logging

Push

Pushes translation files to the API, translation files can be configured in wordsmith.yml, see Configuration

short long type default description
-e --env String wordsmith.yml Path to the configuration file
--access-token String wordsmith.yml Access token
-f --force Bool false Overwrite existing translations
-v --verify Bool false Verify pushed translations
--verbose Bool false Enables verbose logging

Configuration

Wordsmith CLI accepts YAML configuration files, the default configuration file is wordsmith.yml but can be overwritten using the --env flag on push and pull commands

Top level

name type description
project-id Number ID of the project
token String Access token or environment variable for access token, default: ${{ WORDMSMITH_ACCESS_TOKEN }}
targets Target[] See Targets

Targets

Any remaining properties will be passed on to the API when pushing or pulling.

name type description
file String Path to the translation file, {locale} will be replaced with the locale e.g. values-{locale}/strings.xml will become values-en/strings.xml
default-locale-override String? Path override for the default locale, this may be useful on Android where the default strings are stored in values/ instead of values-{locale}/
locales String[] Locales to pull/push, defaults to existing project locales
types (pull \| push)[] Enables push and/or pull for this target
file-type String The file format of the translation file, see Supported formats
tags String[] Pull only translations with given tags or attach tags to pushed translations, defaults to []

Supported formats

Example Configuration

All versions of wordsmith-cli with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package owowagency/wordsmith-cli contains the following files

Loading the files please wait ....