Zaahir Moolla > App-DuckPAN > duckpan

Download:
App-DuckPAN-0.156.tar.gz

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

duckpan - Command line tool for using the DuckPAN of DuckDuckGo

VERSION ^

version 0.156

DESCRIPTION ^

See App::DuckPAN for more information.

DuckPAN ^

The DuckDuckHack Testing Tool

SYNPOSIS

DuckPAN is an application built to provide developers a testing environment for DuckDuckHack Instant Answers. It allows you to test instant answer triggers and preview their visual design and output.

INSTALLATION

Please see https://github.com/duckduckgo/p5-app-duckpan#installing-duckpan for all information regarding the installation of DuckPAN.

COMMANDS

duckpan check: Checks if you fulfill all requirements for the development environment. This will run automatically during a duckpan release.

duckpan query [spice_package|goodie_package] Test Goodie and Spice triggers interactively on the command line. For each query, the instant answers triggered will be displayed. This tool should be used to ensure your instant answer triggers correctly.

    [spice_package|goodie_package]:
        Loads the specified spice or goodie instant answer only
        duckpan query Spice::Npm
        duckpan query Goodie::MD5

duckpan server [--verbose] [--no-cache] [--port <number>] [spice_package|goodie_package] Starts a local web server, which emulates the DuckDuckGo production environment. Allows for live testing of Goodie and Spice instant answers. This tool should be used to ensure your instant answer displays correctly. For Spice instant answers, this is especially important to verify API calls are successful and no JavaScript errors exist.

    -v, --verbose:
        Provides more output from server

    --no-cache:
        Forces the cache to be repopulated each time the server starts (defaults to using cached copies of assets unless newer versions exist)

    -p, --port <number>:
        Forces DuckPAN server to run on the specified port (default port is 5000)

    [spice_package|goodie_package]:
        Loads the specified spice or goodie instant answer only
        duckpan server Spice::Npm
        duckpan server Goodie::MD5

duckpan help: Shows you the DuckPAN help page which briefly describes DuckPAN and its features.

duckpan test: Tests your release, by running the tests in the t/ directory using Dzil (if a dist.ini exists) or prove. This will run automatically during a duckpan release.

duckpan installdeps: Attempt to install dependencies for the distribution in your current directory using cpanm.

duckpan roadrunner: Same as installdeps, but without testing them. Meep meep!

duckpan poupload: Upload a po file to the Community Platform. This is for Translation Managers only.

duckpan publisher: Starts a local web server which displays static websites created with DuckDuckGo-Publisher.

duckpan release: Pushes a new release of the current project (ie. Spice, Goodie or Publisher) to DuckPAN.org

duckpan setup: Helps configure your environment so you can use Dist::Zilla::Plugin::UploadToDuckPAN, which is used by duckpan release.

duckpan update: Update DuckPAN to the latest version.

duckpan upgrade: Upgrade DuckPAN and DDG to the latest versions.

duckpan reinstall: Force installation of the latest released versions of DuckPAN and DDG.

ENVIRONMENT VARIABLES

duckpan env name value Add an environment variable that DuckPAN will remember. This is specifically useful for Spice API keys. Variables are stored in ~/.duckpan/env.ini

duckpan env rm name Remove an environment variable from DuckPAN.

PARAMETERS

duckpan -Ilib: Loads the specified external library. This should be used to test changes made to App::DuckPAN and DDG. Example: loading modified DuckPAN modules duckpan -I../p5-app-duckpan/lib server.

SEE ALSO ^

https://github.com/duckduckgo/p5-app-duckpan
https://github.com/duckduckgo
https://duckduckgo.com
https://duck.co
http://duckpan.org

CONTRIBUTION ^

To contribute to DuckPAN, please visit https://github.com/duckduckgo/p5-app-duckpan. We also welcome and encourage contributions from our community. Please visit http://duckduckhack.com/ to contribute new instant answers, or visit https://duck.co/ideas to share your ideas and instant answer source suggestions.

SUPPORT

IRC:

    We invite you to join us at B<#duckduckgo> on B<irc.freenode.net> for any queries and lively discussion.

Repository:

    L<https://github.com/duckduckgo/p5-app-duckpan>

Issue Tracker:

    https://github.com/duckduckgo/p5-app-duckpan/issues

AUTHOR ^

Torsten Raudssus <torsten@raudss.us> https://raudss.us/

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by DuckDuckGo, Inc. https://duckduckgo.com/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: