Example
```javascript
var obj = {};
obj.username = "user";
obj.password = "!Q@W3e4r";
obj.realm = "domain";
obj.type = "password";
obj.host = "DB";
var arr = [];
arr.push(obj);
ax.credentials_add_list(arr);
```
***
### create\_command
[See here](/adaptix-framework/development/axscript/axcommand-type.md#command)
***
### create\_commands\_group
[See here](/adaptix-framework/development/axscript/axcommand-type.md#registering-commands)
***
### decode\_data
Return decoded base64 data from algorithm ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.decode_data(string algorithm, string base64data, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `base64data` - data in base64
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.decode_data("xor", "GAAaQ1dH", "key123");
```
***
### decode\_file
Return decoded base64 data from algorithm ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.decode_file(string algorithm, string filepath, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `filepath` - file with data in base64
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.decode_data("xor", "/tmp/encfile.txt", "key123");
```
***
### encode\_data
Return encoded data ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.encode_data(string algorithm, string data, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `data` - data for encoding
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.encode_data("xor", "secret", "key123");
```
***
### encode\_file
Return encoded data ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.encode_data(string algorithm, string filepath, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `filepath` - file with data in base64
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.encode_data("xor", "/tmp/encfile.txt", "key123");
```
***
### execute\_alias
[See here](/adaptix-framework/development/axscript/axcommand-type/commands-and-hooks.md#execute_alias)
***
### execute\_browser
[See here](/adaptix-framework/development/axscript/axcommand-type/commands-and-hooks.md#execute_browser)
***
### execute\_command
[See here](/adaptix-framework/development/axscript/axcommand-type/commands-and-hooks.md#execute_command)
***
### file\_basename
Returns the filename
```javascript
string ax.file_basename(string path);
```
* `path` - full filename
Example
```javascript
ax.file_basename("/tmp/test.txt");
```
***
### file\_dirname
Returns the base directory name
```javascript
string ax.file_dirname(string path);
```
* `path` - full filename
Example
```javascript
ax.file_dirname("/tmp/test.txt");
```
***
### file\_exists
Checks if a file exists
```javascript
bool ax.file_exists(string path);
```
* `path` - full filename
Example
```javascript
ax.file_exists("/tmp/test.txt");
```
***
### file\_extension
Checks if a file exists
```javascript
string ax.file_extension(string path);
```
* `path` - full filename
Example
```javascript
ax.file_extension("/tmp/test.txt");
```
***
### file\_read
Reads a file and returns base64 encoded contents
```javascript
string ax.file_read(string path);
```
* `path` - full filename
Example
```javascript
ax.file_read("/tmp/test.txt");
```
***
### file\_size
Return the file size
```javascript
int ax.file_size(string path);
```
* `path` - full filename
Example
```javascript
ax.file_size("/tmp/file.txt");
```
***
### file\_write\_text
Writes text data to a file and returns true if the write is successful.
```javascript
bool ax.file_write_text(string path, string text);
```
* `path` - full filename
* `text` - text data
Example
```javascript
ax.file_write_text("/tmp/test.txt", "this is text");
```
***
### file\_write\_binary
Writes base64 data to a file and returns true if the write is successful.
```javascript
bool ax.file_write_binary(string path, string b64text);
```
* `path` - full filename
* `b64text` - base64 data
Example
```javascript
ax.file_write_binary("/tmp/file2.txt", "dGVzdCBtZXNzYWdlCg==");
```
***
### format\_time
Convert UNIX Epoch Time to date/time string value.
```javascript
string ax.format_time(string format, int unixtime);
```
* `format` - datetime format (e.g. "dd/MM/yyyy hh:mm:ss")
* `unixtime` - UNIX Epoch Time value
Example
```javascript
ax.format_time("dd/MM hh:mm", ax.ticks());
```
***
### format\_size
Converts bytes into a convenient format
```javascript
string ax.format_size(int bytes);
```
Example
***
### get\_commands
Returns a list of available commands for the agent.
```javascript
string[] get_commands(string id);
```
* `id` - agent ID
Example
***
### get\_project
Returns the name of the current project.
```javascript
string get_project();
```
***
### hash
Returns a hash string in hex format.
```javascript
string ax.hash(string algorithm, int length, string data)
```
* `algorithm` - hash "sha1" or "md5";
* `length` - length of the returned string
* `data` - data to be hashed
Example
```javascript
ax.hash("sha1", 8, "data-for-hash");
ax.hash("md5", 32, "data-for-hash");
```
***
### interfaces
Returns a list of network interfaces of the teamserver
```javascript
string[] ax.interfaces()
```
Example
```javascript
ax.interfaces()
```
***
### ids
Returns a list of agent ids
```javascript
string[] ax.ids()
```
Example
***
### is64
Check if a session is on an x64 system or not
```javascript
bool ax.is64(string id);
```
* `id` - agent ID
Example
```javascript
ax.is64("47ca27cf");
```
***
### isactive
Returns true if the agent is active
```javascript
bool ax.isactive(string id);
```
`id` - agent ID
Example
***
### isadmin
Check if a session has admin rights
```javascript
bool ax.isadmin(string id);
```
* `id` - agent ID
Example
```javascript
ax.isadmin("47ca27cf");
```
***
### log / log\_error
Print `text` to AxScript Console.
```javascript
void ax.log(string text);
void ax.log_error(string text);
```
Example
```javascript
ax.log("log");
ax.log_error("log");
```
***
### open\_agent\_console
Open the console to interact with a agent
```javascript
void ax.open_agent_console(string id);
```
* `id` - agent ID
***
### open\_access\_tunnel
Open the tunnel creation dialog window
```javascript
void ax.open_access_tunnel(string id, bool socks4, bool socks5, bool lportfwd, bool rportfwd);
```
* `id` - agent ID
* `socks4` - is agent support socks4
* `socks5` - is agent support socks5
* `lportfwd` - is agent support local port forwarding
* `rportfwd` - is agent support reverse port forwarding
Example
```javascript
ax.open_access_tunnel("47ca27cf", true, true, false, false);
```
***
### open\_browser\_files
Open the File Browser for a agent
```javascript
void ax.open_browser_files(string id);
```
* `id` - agent ID
***
### open\_browser\_process
Open the Process Browser for a agent
```javascript
void ax.open_browser_process(string id);
```
* `id` - agent ID
***
### open\_remote\_terminal
Open the Interactive Terminal for a agent
```javascript
void ax.open_remote_terminal(string id);
```
* `id` - agent ID
***
### open\_remote\_shell
Open the I/O remote shell for a agent
```javascript
void ax.open_remote_shell(string id);
```
* `id` - agent ID
***
### prompt\_confirm
Show a confirm dialog.
```javascript
string prompt_confirm(string caption, string text);
```
* `caption` - title of the dialog
* `text` - Text question
Example
```javascript
ax.prompt_confirm(" ", "Exit main windows?");
```
***
### prompt\_open\_file
Show a file open dialog.
```javascript
string prompt_open_file(string caption = "Select file", string filter = "");
```
* `caption` - title of the dialog
* `filter` - filter for selecting files
Example
```javascript
ax.prompt_open_file("Select AxScript", "AxScript Files (*.axs)");
```
***
### prompt\_open\_dir
Show a directory open dialog.
```javascript
string prompt_open_dir(string caption = "Select directory");
```
* `caption` - title of the dialog
Example
```javascript
ax.prompt_open_dir("Open directory");
```
***
### prompt\_save\_file
Show a file save dialog.
```javascript
string prompt_save_file(string filename, string caption = "Select file", string filter = "");
```
* `filename` - default filename
* `caption` - title of the dialog
* `filter` - filter for selecting files
Example
```javascript
ax.prompt_save_file("/tmp/creds.txt", "Save file");
```
***
### random\_string
Generates a random string of length `len` from a set of characters `set`.
```javascript
string random_string(int len, string set);
```
* `set` - set of characters (`alphanumeric`, `alphabetic`, `numeric` or `hex`)
Example
```javascript
ax.random_string(10, "hex")
ax.random_string(36, "alphanumeric")
```
***
### random\_int
Generates a random int value.
```javascript
int random_int(int min, int max);
```
* `min` - min value
* `max` - max value
Example
```javascript
ax.random_int(2, 1024)
```
***
### register\_commands\_group
[See here](/adaptix-framework/development/axscript/axcommand-type.md#registering-commands)
***
### script\_import
Import AxScript script into current script's env.
```javascript
string script_import(string path);
```
* `path` - path to script file
***
### script\_load
Load a new script to AxScript Manager
```javascript
string script_load(string path);
```
* `path` - path to script file
***
### script\_unload
Unload a script from the AxScript Manager
```javascript
string script_unload(string path);
```
* `path` - path to script file
***
### script\_dir
Returns the directory where the script is located.
```javascript
string script_dir();
```
***
### show\_message
Shows a message to the user in a dialog box. Use this function to relay information.
```javascript
void show_message(string title, string text);
```
* `title` - title of the dialog
* `text` - the message text
Example
```javascript
ax.show_message("Info", "This is text");
```
***
### targets\_add
Save the specified target in Targets Manager
```javascript
void ax.targets_add(string computer, string domain, string address, string os = "unknown", string osDesc = "", string tag = "", string info = "", bool alive = true);
```
* `computer` - computer name
* `domain` - domain name
* `address` - IP address
* `os` - OS type (possible "windows", "linux", "macos")
* `osDesc` - detailed information about OS
* `tag` - tag
* `info` - info
* `alive` - true if the host is alive
Example
```javascript
ax.targets_add("DC", "dom.local", "dom.local", "192.168.1.10", "windows");
```
***
### targets\_add\_list
Save a list of targets in the Targets Manager
```javascript
void ax.targets_add_list(target[] array);
```
Example
```javascript
var obj = {};
obj.computer = "DC";
obj.domain = "DOM.LOCAL";
obj.os_desc = "Windows Server 2019";
obj.os = "windows";
obj.alive = true;
obj.tag = "";
obj.info = "from axscript";
var arr = [];
arr.push(obj);
ax.targets_add_list(arr);
```
***
### ticks
UNIX Epoch Time value
```javascript
int ticks();
```
***
### validate\_command
Checks the validity of the entered command and returns full information
```javascript
cmd_info ax.validate_command(string id, string command);
```
* `id` - agent ID
* `command` - agents command
```javascript
// cmd_info STRUCT
bool info["valid"]
string info["message"]
bool info["is_pre_hook"]
bool info["has_output"]
bool info["has_post_hook"]
map{} info["parsed"]
```
Example
```javascript
let cmd = ax.validate_command("551757de", "socks start 1080");
cmd.valid
let cmd = ax.validate_command("551757de", "socks start");
cmd.message
```
***
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://adaptix-framework.gitbook.io/adaptix-framework/development/axscript/axfunction.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.