Pi:CLI - Revision history

SirCliveSinclairbot: via /pi-wiki-publish

2026-05-02T08:50:50Z

via /pi-wiki-publish

← Older revision		Revision as of 09:50, 2 May 2026
Line 25:		Line 25:
	* nextpi-admin_disable		* nextpi-admin_disable
	* nextpi-admin_enable		* nextpi-admin_enable
	* nextpi-admin_pupextract		* [[Pi:admin_pupextract\|nextpi-admin_pupextract]]
	* nextpi-admin_report		* nextpi-admin_report
	* nextpi-admin_uihelper		* nextpi-admin_uihelper

Xalior: (adding the missing ref to the speech API, to remind me that is another page I need to create)

2025-11-27T19:26:14Z

(adding the missing ref to the speech API, to remind me that is another page I need to create)

← Older revision		Revision as of 20:26, 27 November 2025
Line 54:		Line 54:
	* nextpi-play_silence		* nextpi-play_silence
	* nextpi-play_sndh		* nextpi-play_sndh
			* nextpi-play_speech
	* nextpi-play_stock		* nextpi-play_stock
	* nextpi-play_stop		* nextpi-play_stop

Xalior at 13:59, 6 February 2024

2024-02-06T13:59:45Z

← Older revision		Revision as of 14:59, 6 February 2024
Line 44:		Line 44:
	* nextpi-file_stream		* nextpi-file_stream
	* nextpi-file_transmit		* nextpi-file_transmit
	* [[Pi:gpio_mode\|nextpi-gpio_mode]]		* [[Pi:gpio_mode\|nextpi-gpio_mode]]
	* nextpi-input_xbox		* nextpi-input_xbox
	* nextpi-play_midiLQ		* nextpi-play_midiLQ

Xalior: /* CLI commands */

2024-02-06T13:52:59Z

CLI commands

← Older revision		Revision as of 14:52, 6 February 2024
Line 44:		Line 44:
	* nextpi-file_stream		* nextpi-file_stream
	* nextpi-file_transmit		* nextpi-file_transmit
			* [[Pi:gpio_mode\|nextpi-gpio_mode]]
	* nextpi-input_xbox		* nextpi-input_xbox
	* nextpi-play_midiLQ		* nextpi-play_midiLQ

Xalior: /* Background Information */

2024-01-05T12:14:36Z

Background Information

← Older revision		Revision as of 13:14, 5 January 2024
Line 1:		Line 1:
	== ~~Background Information~~ ==		== Abstract ==

	The NextPi CLI API is a series of "supported" ~~wrappers around task~~ specific ~~Linux commands~~.		The NextPi CLI API is a series of "supported" command-line tools designed to make performing specific Pi orientated tasks easier for Spectrum Next application developers.

	~~By supported we mean~~ that by ~~using~~ these wrappers vs the ~~underlying~~ commands ~~if things~~ should change ~~within NextPi/tools swapped~~ for any reason~~/etc~~. the ~~commandline switches as documented here~~ can be ~~automatically translated~~ to ensure ~~compatability~~ with any ~~software~~ you'~~ve written~~.		The CLI API commands are built out of two parts - known as "Frontends" and "Backends". "Frontends" commands all begin with <code>nextpi-</code> and broken into logical groups (e.g. <code>nextpi-console_</code>, <code>nextpi-play_</code>, <code>nextpi-admin_</code>, etc) - this naming convention allows you to easily tell at a glance what kind of function a command will perform, and for you to know that your commands should continue to work in future NextPi patches.

			== More About Frontends & Backends ==

			The '''Frontend''' commands often perform their operations via the means of various internal system APIs - in a more traditional Linux setup these Frontends would be called "wrapper scripts". The underlying system tools used by Frontends are what we referred to as '''Backends''' - and you'll often see this term used on individual API CLI pages.

			The use of a "formal CLI API" via these Frontend wrappers permits several things:
			* The addition of extra options and commandline switches not present in the backends;
			* The inclusion of default parameters for many of the commands, or to save boilerplate options; and
			* A way of "future-proofing" should the backend need to change for any reason.

			Many of the backends support additional options, which can be found by reading the documentation for the individual backends (not included in this wiki) - while this may provide you with extra functionality, it comes at the cost of no assurance that these "undocument features" will also continue to work in future NextPi patches.

			== Defining "supported" ==

			In the context of the CLI API "supported" means we will try with "best effort" to ensure that documented usage patterns will continue to work. It does not mean that they come with any warrenty of "technical support", actual or implied - to make these APIs work with your own code. Developer support is community provided, and if you're looking for help the best place to try is the Official Spectrum Next discord, found at https://zxn.gg/discord.

	== CLI commands ==		== CLI commands ==

Xalior at 11:45, 5 January 2024

2024-01-05T11:45:14Z

← Older revision		Revision as of 12:45, 5 January 2024
Line 1:		Line 1:
			== Background Information ==

			The NextPi CLI API is a series of "supported" wrappers around task specific Linux commands.

			By supported we mean that by using these wrappers vs the underlying commands if things should change within NextPi/tools swapped for any reason/etc. the commandline switches as documented here can be automatically translated to ensure compatability with any software you've written.

			== CLI commands ==

	* nextpi-admin_clean		* nextpi-admin_clean
	* nextpi-admin_disable		* nextpi-admin_disable

Xalior at 01:21, 5 January 2024

2024-01-05T01:21:11Z

← Older revision		Revision as of 02:21, 5 January 2024
Line 10:		Line 10:
	* nextpi-cache		* nextpi-cache
	* nextpi-cache_bucket		* nextpi-cache_bucket
	* nextpi-console_image		* [[Pi:console_image\|nextpi-console_image]]
	* nextpi-console_resolution		* [[Pi:console_resolution\|nextpi-console_resolution]]
	* nextpi-dongle_disable		* nextpi-dongle_disable
	* nextpi-dongle_enable		* nextpi-dongle_enable

Xalior: Add references to new 1.92D commands to manipulate console

2024-01-05T01:20:15Z

Add references to new 1.92D commands to manipulate console

← Older revision		Revision as of 02:20, 5 January 2024
Line 10:		Line 10:
	* nextpi-cache		* nextpi-cache
	* nextpi-cache_bucket		* nextpi-cache_bucket
	* nextpi-~~cache_file~~		* nextpi-console_image
			* nextpi-console_resolution
	* nextpi-dongle_disable		* nextpi-dongle_disable
	* nextpi-dongle_enable		* nextpi-dongle_enable

Xalior: Add new CLI commands for KS2GMs

2023-09-07T14:37:17Z

Add new CLI commands for KS2GMs

← Older revision		Revision as of 15:37, 7 September 2023
Line 2:		Line 2:
	* nextpi-admin_disable		* nextpi-admin_disable
	* nextpi-admin_enable		* nextpi-admin_enable
			* nextpi-admin_pupextract
	* nextpi-admin_report		* nextpi-admin_report
			* nextpi-admin_uihelper
	* nextpi-admin_update		* nextpi-admin_update
	* nextpi-admin_version		* nextpi-admin_version
Line 19:		Line 21:
	* nextpi-file_transmit		* nextpi-file_transmit
	* nextpi-input_xbox		* nextpi-input_xbox
			* nextpi-play_midiLQ
			* nextpi-play_midiHQ
			* nextpi-play_midiMQ
	* nextpi-play_mod		* nextpi-play_mod
	* nextpi-play_mp3		* nextpi-play_mp3
	* nextpi-play_sid		* nextpi-play_sid
	* nextpi-play_silence		* nextpi-play_silence
			* nextpi-play_sndh
	* nextpi-play_stock		* nextpi-play_stock
	* nextpi-play_stop		* nextpi-play_stop

Xalior: Brute force music terminator, and stock media player

2021-09-12T14:33:59Z

Brute force music terminator, and stock media player

← Older revision		Revision as of 15:33, 12 September 2021
Line 23:		Line 23:
	* nextpi-play_sid		* nextpi-play_sid
	* nextpi-play_silence		* nextpi-play_silence
	* nextpi-~~play_sndh~~		* nextpi-play_stock
			* nextpi-play_stop
	* nextpi-plus_activate		* nextpi-plus_activate
	* nextpi-plus_list		* nextpi-plus_list